Seller
Api
Ввести Client ID и API Key

Документация Ozon Seller API (2.1)

По вопросам работы с Seller API обращайтесь в поддержку через личный кабинет.

Инструкции по работе с маркетплейсом

Информационная платформа и сообщество разработчиков Ozon for dev

banner-imagebanner-image

Введение

Что такое Ozon Seller API

Ozon Seller API — программный интерфейс для работы с маркетплейсом Ozon. Он даёт возможность обмениваться информацией между системой продавца и Ozon.

Методы Seller API позволяют изменять данные магазина, например, остатки товаров или их стоимость, и получать данные, такие как информация о возвратах или список складов.

Работа с API состоит из отправки запроса и получения ответа. Для этого можно использовать вкладку Консоль, которая находится сверху описания методов, Postman или настроить интеграцию с системами учёта, например, 1С, ERP или МойСклад.

Когда пригодится Seller API

При интеграции системы учёта продавца с Seller API обновлять и получать данные можно в автоматическом режиме. Это поможет поддерживать актуальной информацию о ценах и остатках товаров, обрабатывать больше заказов за меньшее время и исключить ошибки из-за обновления данных вручную.

Например, вам нужно обновить информацию об остатках или ценах 100 товаров. Чтобы сделать это через личный кабинет, необходимо вручную изменить данные на карточке каждого товара.

Метод /v2/products/stocks позволяет одним запросом обновить информацию об остатках сразу 100 товаров, а метод /v1/product/import/prices — их стоимость.

Возможности Seller API

  • Загружать и обновлять товары.
  • Управлять ценами и остатками по товарам.
  • Получать информацию о возвратах товаров.
  • Управлять заказами FBO, FBS и rFBS.
  • Управлять чатами.
  • Работать с накладными.
  • Получать финансовую и аналитическую информацию.
  • Получать выгрузку атрибутов и характеристик Ozon.

Начало работы


Перед началом работы с Ozon Seller API:

  1. Изучите процессы работы с Ozon в Базе знаний продавца и личном кабинете продавца.
  2. Определите процессы, которые планируете автоматизировать, и сравните их с процессами вашей компании.
  3. Изучите документацию Seller API и разработайте схему интеграции.

Для работы с Seller API необходим API-ключ. Подробнее в разделе Авторизация.

Seller API работает по UTC. Учитывайте это, когда отправляете запросы и получаете ответы с датами и временем.

Процесс работы с Seller API можно разделить на блоки:

  • работа с атрибутным деревом,
  • загрузка и обновление товаров,
  • управление ценами,
  • управление остатками товара,
  • управление заказами FBO,
  • управление заказами FBS и rFBS,
  • работа с накладными,
  • получение финансовой информации,
  • получение аналитической информации,
  • управление возвратами,
  • управление чатами.

Авторизация


Как получить доступ к Seller API

  1. Зарегистрируйтесь в Ozon Seller. Подробнее о регистрации в Базе знаний продавца.
  2. Получите API-ключ.

Как получить API-ключ

Чтобы получить API-ключ:

  1. В личном кабинете перейдите в Настройки → Seller API.
  2. Нажмите Сгенерировать ключ.
  3. Придумайте название для ключа и выберите его уровень доступа.
  4. Нажмите Сгенерировать.

Вы можете создать несколько API-ключей. Например, если у вас несколько пользователей с разными уровнями доступа.

Отредактировать ключ

Если вы хотите изменить разрешённые сети для ключа, в списке API-ключей выберите нужный и нажмите . Внесите изменения и нажмите Обновить.

API-ключ попал в посторонние руки

  1. В личном кабинете перейдите в Настройки → Seller API.
  2. Удалите текущий API-ключ и создайте новый.

Рабочая среда

Что такое рабочая среда

Рабочая среда — это ваш магазин. Все отправленные запросы, кроме информационных, могут изменять данные в личном кабинете и на сайте Ozon.

Рабочая среда: api-seller.ozon.ru

Созданные товары можно посмотреть по ссылке вида: https://www.ozon.ru/context/detail/id/SKU, где вместо «SKU» нужно указать значение для созданного товара.

Формат запроса

GET / HTTP/1.1
Host: api-seller.ozon.ru
Client-Id: <Client-Id>
Api-Key: <Api-Key>
Content-Type: application/json

Для проверки корректности формата запроса используйте вкладку Консоль над описанием метода или Postman.

Порядок работы с методами


Выгрузите атрибуты и характеристики Ozon


  1. /v1/description-category/tree — получите список категорий и типов в виде дерева и используйте значение последнего уровня выбранной категории.

  2. /v1/description-category/attribute — получите характеристики для выбранных категории и типа.

  3. /v1/description-category/attribute/values — получите список значений для выбранной характеристики.

Загрузите и обновите товары

После сравнения своих атрибутов и характеристик с атрибутной моделью Ozon можете приступить к загрузке товаров:

  1. /v3/product/import — загрузите товары и услуги. Этот метод также позволяет обновить уже загруженные товары. В запросе устанавливается первичная цена и загружаются изображения товара.

    В одном запросе можно передать до 100 товаров. Изображения загружаются прямой ссылкой на облачное хранилище, где они хранятся.

    В результате работы метода вы получите task_id — номер задания на загрузку товаров.

  2. /v1/product/import/info — проверьте task_id, который вы получили при загрузке товаров. Метод вернёт информацию, успешно ли загрузились товары или при импорте была ошибка.

    Если ответ содержит статус, что товар на модерации, подождите её результатов и проверьте статус товара повторно. Обычно модерация занимает меньше одного дня.

  3. /v1/product/upload_digital_codes — загрузите коды активации, если вы продаёте цифровые товары или услуги. Код активации привязывается к карточке цифрового товара. После продажи цифрового товара вы сможете посмотреть привязку кода к отправлению в ответе метода /v2/posting/fbo/get. В результате работы метода вы получите task_id — номер задания на загрузку кода активации.

  4. /v1/product/upload_digital_codes/info — проверьте task_id, который вы получили при загрузке кодов активации. Метод вернёт информацию, успешно ли загрузились коды или возникла ошибка.

  5. /v3/product/list — получите список созданных товаров после загрузки товаров.

    Метод позволяет использовать фильтры, чтобы разбить товары на группы по статусу видимости или отслеживать изменение их статуса с помощью идентификатора товара.

    Метод возвращает пару значений offer_id и product_id — они нужны практически во всех запросах для идентификации товара, с которым будет производиться действие. Если вы загружали товары через шаблон, используйте этот метод для получения offer_id и product_id, чтобы в дальнейшем работать по API с товарами.

Загрузите и обновите изображения товара

Чтобы добавить изображения товара или заменить существующие, используйте:

  1. /v1/product/pictures/import — загрузите или обновите изображения товара. Передайте прямые ссылки на изображения, загруженные в облачное хранилище.
  2. /v2/product/pictures/info — проверьте статус загрузки.

Обновите товар

Чтобы обновить информацию о товаре и его характеристики, используйте /v3/product/import.

Если нужно обновить только характеристики товара, используйте /v1/product/attributes/update.

Получите информацию о товаре

  • /v3/product/info/list — получите информацию о товаре, например штрихкод, цену главного предложения, идентификатор категории, комиссию или ошибки модерации. С помощью фильтров /v3/product/list получите список пакетно по всем товарам сразу или по категориям.

  • /v4/product/info/attributes — получите описание характеристик товара. Метод позволяет добавить дополнительную информацию к товару, чтобы карточка товара была более полной.

  • /v1/product/info/description — получите описание товара, чтобы использовать его для создания схожего товара.

  • /v1/product/info/discounted — получите информацию об уценке и основном товаре по SKU уценённого товара.

Удалите или архивируйте товар

  1. /v2/products/delete — удалите товар, если он загрузился с ошибкой и попал в архив без SKU. Товары, которые успешно прошли модерацию и получили SKU, удалить из архива нельзя.

  2. /v1/product/archive — перенесите товар в архив. Перед архивированием товара обнулите его остатки.

  3. /v1/product/unarchive — верните товар из архива.

Товар попадёт в продажу, только когда вы установите его остаток.

Управляйте услугами

Загрузить коды активации для услуг и цифровых товаров можно через метод /v1/product/upload_digital_codes.

Загрузите сертификаты качества

Информация о сертификатах

Работа с товарами сертификата

Чтобы привязать сертификат к товару:

  1. Получите список брендов, для которых требуется предоставить сертификат: /v1/brand/company-certification/list. В ответе вернутся бренды, товары которых есть в вашем личном кабинете. Список брендов может изменяться, если Ozon получит требование от бренда предоставлять сертификат.
  2. Добавьте сертификаты для товаров: /v1/product/certificate/create.
  3. Привяжите сертификат к товару: /v1/product/certificate/bind.

Чтобы посмотреть список товаров, привязанных к сертификату, воспользуйтесь методом v1/product/certificate/products/list. Если нужно получить список товаров с определённым статусом, в параметре status передайте значение code из ответа v1/product/certificate/product_status/list.

Чтобы отвязать товар от сертификата, используйте /v1/product/certificate/products/unbind.

Управление состоянием сертификата

Чтобы получить атрибуты для управления сертификатом:

  1. Получите список типов сертификатов: /v1/product/certificate/types.
  2. Получите список типов соответствия требованиям: /v2/product/certificate/accordance-types/list.

Для создания сертификата используйте /v1/product/certificate/create, передав в запросе:

Чтобы удалить сертификат, используйте /v1/product/certificate/delete.

Обновите цены и остатки товаров

После загрузки товаров для схем FBS и rFBS можно перейти к обновлению остатков. Для схемы FBO остатки обновляются автоматически по факту продажи.

Для обновления остатков используйте методы:

  • /v1/product/import/stocks — если у вас заведён один склад.
  • /v2/products/stocks — если складов несколько. В этом методе дополнительно указывается идентификатор склада, на котором необходимо изменить остатки.

Для получения информации о количестве остатков для FBO используйте /v3/product/info/stocks.

Для получения информации о количестве остатков для FBS и rFBS используйте v1/product/info/stocks-by-warehouse/fbs.

Чтобы обновить цены по товарам и не менять карточку товара, используйте /v1/product/import/prices.

Метод позволяет обновить цену:

  • до скидок,
  • для клиентов с подпиской Ozon Premium,
  • на карточке товара с учётом скидок,
  • минимальную цену товара после применения акций.

Для получения информации о ценах, комиссиях и скидках на товары используйте /v5/product/info/prices.

Резерв товаров

Если товары заказывают юридические лица, оплата может поступать не сразу — система зарезервирует товары. Чтобы проверить остатки, используйте методы /v3/posting/fbs/get, /v3/posting/fbs/list или /v3/posting/fbs/unfulfilled/list. Если в ответе is_legal = true, значит среди остатков есть зарезервированные товары. Вы можете обновить остатки так, чтобы новое количество товаров было больше свободного остатка и зарезервированного товара в сумме. Система спишет старый остаток и рассчитает новый.

Чтобы проверить резервирование товара, используйте метод /v3/product/info/stocks.

Подробнее об изменении остатков

Участвуйте в акциях

Для продвижения товаров участвуйте в акциях, которые Ozon проводит для покупателей.

Покупатели могут попросить у вас скидку на товар. Чтобы получить список товаров, которые покупатели хотят купить со скидкой, воспользуйтесь методом /v1/actions/discounts-task/list. Заявки в статусах NEW (новые) или SEEN (просмотренные) вы можете:

Подробнее об акциях в Базе знаний продавца

Настройте стратегии ценообразования

Стратегии ценообразования — инструмент для автоматического изменения стоимости товаров в соответствии с ценами на аналогичные товары в других интернет-магазинах и маркетплейсах.

Подробнее о стратегиях в Базе знаний для продавцов из России

Подробнее о стратегиях в Справке для продавцов Ozon Global

Чтобы настроить стратегии ценообразования:

  1. Получите список конкурентов: /v1/pricing-strategy/competitors/list.

  2. Получите список стратегий ценообразования: /v1/pricing-strategy/list.

  3. Создайте свою стратегию: /v1/pricing-strategy/create и установите коэффициенты, чтобы изменять стоимость товара по сравнению с другими площадками в большую и меньшую сторону. Чтобы получить информацию о стратегии, используйте метод /v1/pricing-strategy/info.

  4. Добавьте товары в стратегию: /v1/pricing-strategy/products/add.

    Вы можете добавить товары:

    Чтобы получить список товаров, которые привязаны к стратегии, используйте метод /v1/pricing-strategy/products/list, а для удаления товаров из стратегии — /v1/pricing-strategy/products/delete.

  5. Включите или отключите стратегию: /v1/pricing-strategy/status.

Чтобы изменить список выбранных конкурентов и название стратегии, используйте метод /v1/pricing-strategy/update.

Для удаления стратегии используйте метод /v1/pricing-strategy/delete.

Получите информацию о складах

Схема FBO

Перед созданием заявки на поставку проверьте загруженность складов Ozon: /v1/supplier/available_warehouses.

Для получения списка отправлений, финансовой и аналитической информации используйте /v2/posting/fbo/list. Также метод возвращает информацию о проданных кодах активации с привязкой к номеру отправления.

Чтобы получить информацию по отправлению, используйте /v2/posting/fbo/get.

Создать заявку на поставку

  1. /v1/cluster/list — получите информацию по кластерам и их складам.
  2. /v1/warehouse/fbo/list — получите идентификаторы складов, пунктов выдачи заказов и сортировочных центров для отгрузки кросс-докингом.
  3. /v1/draft/create — создайте черновик заявки на поставку. Для этого передайте список поставляемых товаров, тип поставки и, при доставке кросс-докингом, точку отгрузки.
  4. /v1/draft/create/info — получите статус создания черновика и информацию по нему.
  5. /v1/draft/timeslot/info — получите доступные таймслоты для конечных складов отгрузки. Максимальный период — 28 дней, начиная с текущей даты.
  6. /v1/draft/supply/create — создайте заявку на поставку по черновику.
  7. /v1/supply/create/status — получите статус создания заявки на поставку. Когда заявка будет создана, метод вернёт идентификаторы заявок на поставку.

Получите информацию о заявках на поставку

Для поставки на фулфилмент Ozon нужна заявка. В ней указано, какие товары и в каком количестве вы привезёте.

  1. /v2/supply-order/list — получите список заявок на поставку.
  2. /v1/supply-order/status/counter — получите статус заявки и количество поставок в этом статусе.
  3. /v2/supply-order/get — получите информацию по заявке.
  4. v1/supply-order/bundle — получите состав поставки или заявки на поставку.

Для проезда на фулфилмент выберите интервал поставки и оформите пропуск для водителя и автомобиля. Для этого:

  1. /v1/supply-order/timeslot/get — получите список доступных интервалов.
  2. /v1/supply-order/timeslot/update — измените выбранный интервал.
  3. /v1/supply-order/timeslot/status — получите статус закрепления интервала.
  4. /v1/supply-order/pass/create — добавьте данные водителя и автомобиля.
  5. /v1/supply-order/pass/status — получите статус ввода данных о водителе и автомобиле.

Управляйте грузоместами в заявке на поставку

  1. /v1/cargoes/create — передайте количество грузомест и установите в каждое грузоместо товарный состав.
  2. /v1/cargoes/create/info — получите информацию по установке грузомест и товарного состава.
  3. /v1/cargoes-label/create — создайте задание на формирование этикеток грузомест.
  4. /v1/cargoes-label/get — получите статус создания этикеток и идентификатор файла с ними.
  5. /v1/cargoes-label/file/{file_guid} — получите PDF с этикетками грузовых мест.

Схема FBS Стандарт

  1. Перед началом работы с отправлениями получите список необработанных отправлений: /v3/posting/fbs/unfulfilled/list.

    Если покупатель юридическое лицо, то в блоке requirements будет информация о необходимости передать страну-производителя для всех товаров в заказе, у которых она не указана. Получите список доступных для выбора стран: /v2/posting/fbs/product/country/list. Затем передайте информацию о стране-производителе: /v2/posting/fbs/product/country/set.

    Также можно получать список заказов (отправлений): /v3/posting/fbs/list. Он позволяет получить все заказы, используя фильтры с различными статусами. Можно также получить данные аналитики, если поле with отправить со значением analytics_data.

    Отправления могут прийти в статусах awaiting_packaging, awaiting_approve или awaiting_verification.

  2. Получите дополнительную информацию о заказах: /v3/posting/fbs/get.

    В блоке requirements указывается:

    • какие товары подлежат обязательной маркировке;
    • нужно ли передать номер грузовой таможенной декларации и регистрационный номер партии товара — эту информацию также можно получить с помощью методов /v3/posting/fbs/list и /v3/posting/fbs/unfulfilled/list.

    Дополнительную информацию вы также можете получить по штрихкоду: /v2/posting/fbs/get-by-barcode.

  3. Проверьте, что коды маркировки соответствуют требованиям системы «Честный ЗНАК» по составу и количеству символов: /v4/fbs/posting/product/exemplar/validate.

    Получите идентификаторы экземпляров exemplar_id методом /v5/fbs/posting/product/exemplar/create-or-get.

    С помощью метода /v5/fbs/posting/product/exemplar/set добавьте для каждого экземпляра маркировку, которую будете передавать в систему «Честный ЗНАК». При необходимости передайте номера таможенных деклараций и регистрационные номера партии товара или укажите, что их нет.

    Подробнее о маркировке «Честный ЗНАК» в Базе знаний

    Получите статусы передачи маркировок:

  1. Перед сборкой убедитесь, что отправление соответствует установленным в пункте приёма ограничениям. Получите ограничения пункта приёма по номеру отправления: /v1/posting/fbs/restrictions.

  2. До окончания времени на сборку подтвердите, что вы собрали заказ: /v4/posting/fbs/ship. Вы не сможете собрать заказ, если:

    • заказ не в статусе awaiting_packaging;
    • вы не указали коды маркировки для товаров, подлежащих обязательной маркировке.

    При необходимости используйте этот метод, чтобы разделить заказ на несколько отправлений. Например, если в заказе несколько товаров и их необходимо упаковать в разные коробки, так как вместе они не отвечают требованиям к упаковке.

    После использования метода статус отправления изменится на awaiting_deliver.

    Вы можете использовать метод для частичной сборки: /v4/posting/fbs/ship/package.

  3. Для каждого отправления распечатайте наклейку для идентификации в системе Ozon: /v2/posting/fbs/package-label.

  4. Подтвердите отгрузку и запустите формирование транспортной накладной методом /v2/posting/fbs/act/create или создайте отгрузку с помощью метода /v1/carriage/create и подтвердите её методом /v1/carriage/approve. В ответе методов /v2/posting/fbs/act/create и /v1/carriage/create вы получите идентификатор созданной перевозки.

  5. Запросите информацию о созданной поставке с помощью метода /v1/carriage/get. Массив available_actions содержит информацию о доступных действиях с поставкой и необходимости создать пропуск для проезда на склад Ozon.

    Чтобы создать пропуск, используйте метод /v1/carriage/pass/create. Чтобы после поставки товаров вы могли забрать возвраты на этой же машине, передайте значение with_returns = true. Для каждой поставки нужен новый пропуск.

    Для редактирования или удаления пропуска используйте методы /v1/carriage/pass/update и /v1/carriage/pass/delete.

    Список всех пропусков можно получить с помощью метода /v1/pass/list.

    Подробнее об оформлении пропусков

  6. Получите список перевозок, по которым нужно распечатать штрихкод для отгрузки и транспортную накладную: /v1/posting/carriage-available/list или /v1/carriage/delivery/list.

  7. Проверьте, что отгрузка создана: /v2/posting/fbs/act/check-status.

  8. Получите штрихкод для отгрузки: /v2/posting/fbs/act/get-barcode.

  9. Проверьте статус формирования накладной: /v2/posting/fbs/digital/act/check-status. Когда статус документа перейдёт в FORMED, получите файлы:

После этого можете отвезти отправления и документы в пункт приёма.

Если отправление передано в доставку, но не просканировано в сортировочном центре, вы можете открыть спор: /v2/posting/fbs/arbitration. Открытый спор переведёт отправление в статус arbitration.

Если спор по отправлению откроет покупатель, статус отправления изменится на client_arbitration.

Чтобы отследить изменение статуса, когда отправление найдено, используйте /v3/posting/fbs/list с нужными фильтрами.

Для передачи спорных заказов к отгрузке используйте /v2/posting/fbs/awaiting-delivery. Статус отправления изменится на awaiting_deliver.

Отменить доставку отправления

  1. Используйте /v2/posting/fbs/cancel-reason/list на любом этапе работы с отправлением, чтобы получить список причин отмены отправления.

  2. Передайте этот список и номер отправления: /v2/posting/fbs/cancel.

Чтобы отменить часть товаров в отправлении, используйте /v2/posting/fbs/product/cancel.

Если отправление отменит покупатель, статус изменится на cancelled.

Работа с эконом-товарами

  1. Создайте эконом-товары в личном кабинете.
  2. Получите идентификаторы квантов с созданными товарами: /v1/product/quant/list.
  3. Отслеживайте количество заказанных товаров: /v1/quant/get.
  4. Когда наберётся нужное для кванта количество заказанных товаров, соберите его: v1/quant/ship.

Подробнее об эконом-товарах в Справке

Схема FBS PickUp с доверительной приёмкой

  1. Перед началом работы с отправлениями получите список необработанных отправлений: /v3/posting/fbs/unfulfilled/list.

    Если покупатель юридическое лицо, то в блоке requirements будет информация о необходимости передать страну-производителя для всех товаров в заказе, у которых она не указана. Получите список доступных для выбора стран: /v2/posting/fbs/product/country/list. Затем передайте информацию о стране-производителе: /v2/posting/fbs/product/country/set.

    Также можно получать список заказов (отправлений): /v3/posting/fbs/list. Он позволяет получить все заказы, используя фильтры с различными статусами. Можно также получить данные аналитики, если поле with отправить со значением analytics_data.

    Отправления могут прийти в статусах awaiting_packaging, awaiting_approve или awaiting_verification.

  2. Получите дополнительную информацию о заказах: /v3/posting/fbs/get.

    В блоке requirements указывается:

    • какие товары подлежат обязательной маркировке;
    • нужно ли передать номер грузовой таможенной декларации и регистрационный номер партии товара — эту информацию также можно получить с помощью методов /v3/posting/fbs/list и /v3/posting/fbs/unfulfilled/list.

    Дополнительную информацию вы также можете получить по штрихкоду: /v2/posting/fbs/get-by-barcode.

  3. Проверьте, что коды маркировки соответствуют требованиям системы «Честный ЗНАК» по составу и количеству символов: /v4/fbs/posting/product/exemplar/validate.

    С помощью метода /v5/fbs/posting/product/exemplar/set добавьте для каждого экземпляра маркировку, которую будете передавать в систему «Честный ЗНАК». При необходимости передайте номера таможенных деклараций и регистрационные номера партии товара или укажите, что их нет.

    Подробнее о маркировке «Честный ЗНАК» в Базе знаний

    Получите статусы передачи маркировок:

  1. Перед сборкой убедитесь, что отправление соответствует установленным в пункте приёма ограничениям. Получите ограничения пункта приёма по номеру отправления: /v1/posting/fbs/restrictions.

  2. До окончания времени на сборку подтвердите, что вы собрали заказ: /v4/posting/fbs/ship. Вы не сможете собрать заказ, если:

    • заказ не в статусе awaiting_packaging;
    • вы не указали коды маркировки для товаров, подлежащих обязательной маркировке.

    При необходимости используйте этот метод, чтобы разделить заказ на несколько отправлений. Например, если в заказе несколько товаров и их необходимо упаковать в разные коробки, так как вместе они не отвечают требованиям к упаковке.

    После использования метода статус отправления изменится на awaiting_deliver.

    Вы можете использовать метод для частичной сборки: /v4/posting/fbs/ship/package.

  3. Подтвердите отгрузку и запустите формирование транспортной накладной методом /v2/posting/fbs/act/create или создайте перевозку с помощью метода /v1/carriage/create и подтвердите её методом /v1/carriage/approve. В ответе методов /v2/posting/fbs/act/create и /v1/carriage/create вы получите идентификатор созданной перевозки.

  4. Получите список перевозок, по которым нужно распечатать штрихкод для отгрузки и транспортную накладную: /v1/posting/carriage-available/list или /v1/carriage/delivery/list.

  5. Проверьте статус формирования накладной: /v2/posting/fbs/digital/act/check-status. Когда статус документа перейдёт в FORMED, получите файлы:

  6. Для каждого отправления распечатайте наклейку для идентификации в системе Ozon: /v2/posting/fbs/package-label.

  7. После того как вы упаковали все отправления по требованиям из раздела Доверительная приёмка грузового места в Базе знаний продавца, получите этикетки на каждое грузовое место: /v2/posting/fbs/act/get-container-labels.

После этого можете передать грузовое место в пункт приёма или курьеру Ozon.

Если отправление передано в доставку, но не просканировано в сортировочном центре, вы можете открыть спор: /v2/posting/fbs/arbitration. Открытый спор переведёт отправление в статус arbitration.

Если спор по отправлению откроет покупатель, статус отправления изменится на client_arbitration.

Чтобы отследить изменение статуса, когда отправление найдено, используйте /v3/posting/fbs/list с нужными фильтрами.

Для передачи спорных заказов к отгрузке используйте /v2/posting/fbs/awaiting-delivery. Статус отправления изменится на awaiting_deliver.

Схема rFBS Стандарт

  1. Перед началом работы с отправлениями получите список необработанных заказов (отправлений): /v3/posting/fbs/unfulfilled/list.

    Если покупатель юридическое лицо, то в блоке requirements будет информация о необходимости передать страну-производителя для всех товаров в заказе, у которых она не указана.
    Получите список доступных для выбора стран: /v2/posting/fbs/product/country/list. Затем передайте информацию о стране-производителе: /v2/posting/fbs/product/country/set.

    Также можно получать список заказов (отправлений): /v3/posting/fbs/list. Он позволяет получить все заказы, используя фильтры с различными статусами. Можно также получить данные аналитики, если поле with отправить со значением analytics_data.

    Отправления могут прийти в статусах awaiting_packaging, awaiting_approve или awaiting_verification.

    Если в параметре available_actions указано set_cutoff, уточните дату отгрузки отправления с помощью метода /v1/posting/cutoff/set. Сделайте это не позднее даты, которая указана в параметре shipment_date в методах: /v3/posting/fbs/unfulfilled/list, /v3/posting/fbs/list или /v3/posting/fbs/get. После даты shipment_date уточнить дату отгрузки и собрать отправление не получится.

  2. Получите дополнительную информацию о заказах: /v3/posting/fbs/get.

    В блоке requirements указывается:

    • какие товары подлежат обязательной маркировке;
    • нужно ли передать номер грузовой таможенной декларации и регистрационный номер партии товара — эту информацию также можно получить с помощью методов /v3/posting/fbs/list и /v3/posting/fbs/unfulfilled/list.

    Дополнительную информацию вы также можете получить по штрихкоду: /v2/posting/fbs/get-by-barcode.

  3. Проверьте, что коды маркировки соответствуют требованиям системы «Честный ЗНАК» по составу и количеству символов: /v4/fbs/posting/product/exemplar/validate.

    С помощью метода /v5/fbs/posting/product/exemplar/set добавьте для каждого экземпляра маркировку, которую будете передавать в систему «Честный ЗНАК». При необходимости передайте номера таможенных деклараций и регистрационные номера партии товара или укажите, что их нет.

    Подробнее о маркировке «Честный ЗНАК» в Базе знаний

    Получите статусы передачи маркировок:

  1. До окончания времени на сборку подтвердите, что вы собрали заказ: /v4/posting/fbs/ship. Вы не сможете собрать заказ, если:

    • заказ не в статусе awaiting_packaging;
    • вы не указали коды маркировки для товаров, подлежащих обязательной маркировке.

    При необходимости используйте этот метод, чтобы разделить заказ на несколько отправлений. Например, если в заказе несколько товаров и их необходимо упаковать в разные коробки, так как вместе они не отвечают требованиям к упаковке.

    После использования метода статус отправления изменится на awaiting_deliver.

    Вы можете использовать метод для частичной сборки: /v4/posting/fbs/ship/package.

Когда сборка заказа завершена, свяжитесь с покупателем для согласования даты доставки. Если покупателю не подходит дата, вы можете перенести её: /v1/posting/fbs/timeslot/set. Посмотрите доступные даты для переноса доставки и количество доступных переносов: /v1/posting/fbs/timeslot/change-restrictions.

Передайте отправление курьеру:

  1. Когда курьер забрал отправление, измените статус отправления на «Доставляется»: /v2/fbs/posting/delivering.

    Одновременно с этим, если у отправления есть трек-номер, передайте его: /v2/fbs/posting/tracking-number/set.

  2. Когда курьер едет к покупателю, поменяйте статус отправления на «Последняя миля»: /v2/fbs/posting/last-mile.

  3. Когда курьер передал отправление покупателю, поменяйте статус на «Доставлено»: /v2/fbs/posting/delivered.

Отменить доставку отправления

  1. Используйте /v2/posting/fbs/cancel-reason/list на любом этапе работы с отправлением, чтобы получить список причин отмены отправления.

  2. Передайте этот список и номер отправления: /v2/posting/fbs/cancel.

Чтобы отменить часть товаров в отправлении, используйте /v2/posting/fbs/product/cancel.

Если отправление отменит покупатель, статус изменится на cancelled.

Схема rFBS Express с доставкой в пункт выдачи

  1. Перед началом работы с отправлениями получите список необработанных заказов (отправлений): /v3/posting/fbs/unfulfilled/list.

    Если покупатель юридическое лицо, то в блоке requirements будет информация о необходимости передать страну-производителя для всех товаров в заказе, у которых она не указана. Получите список доступных для выбора стран: /v2/posting/fbs/product/country/list. Затем передайте информацию о стране-производителе: /v2/posting/fbs/product/country/set.

    Также можно получать список заказов (отправлений): /v3/posting/fbs/list. Он позволяет получить все заказы, используя фильтры с различными статусами. Можно также получить данные аналитики, если поле with отправить со значением analytics_data.

    Отправления могут прийти в статусах awaiting_packaging, awaiting_approve или awaiting_verification.

  2. Получите дополнительную информацию о заказах: /v3/posting/fbs/get.

    В блоке requirements указывается:

    • какие товары подлежат обязательной маркировке;
    • нужно ли передать номер грузовой таможенной декларации и регистрационный номер партии товара — эту информацию также можно получить с помощью методов /v3/posting/fbs/list и /v3/posting/fbs/unfulfilled/list.

    Дополнительную информацию вы также можете получить по штрихкоду: /v2/posting/fbs/get-by-barcode.

  3. Проверьте, что коды маркировки соответствуют требованиям системы «Честный ЗНАК» по составу и количеству символов: /v4/fbs/posting/product/exemplar/validate.

    С помощью метода /v5/fbs/posting/product/exemplar/set добавьте для каждого экземпляра маркировку, которую будете передавать в систему «Честный ЗНАК». При необходимости передайте номера таможенных деклараций и регистрационные номера партии товара или укажите, что их нет.

    Подробнее о маркировке «Честный ЗНАК» в Базе знаний

    Получите статусы передачи маркировок:

  1. До окончания времени на сборку подтвердите, что вы собрали заказ: /v4/posting/fbs/ship. Вы не сможете собрать заказ, если:

    • заказ не в статусе awaiting_packaging;
    • вы не указали коды маркировки для товаров, подлежащих обязательной маркировке.

    При необходимости используйте этот метод, чтобы разделить заказ на несколько отправлений. Например, если в заказе несколько товаров и их необходимо упаковать в разные коробки, так как вместе они не отвечают требованиям к упаковке.

    После использования метода статус отправления изменится на awaiting_deliver.

    Вы можете использовать метод для частичной сборки: /v4/posting/fbs/ship/package.

  2. Распечатайте этикетку для идентификации в системе Ozon: /v2/posting/fbs/package-label.

  3. Передайте отправление курьеру.

Дальше подстатусы будут изменяться автоматически:

  1. on_way_to_city — курьер забрал заказ.
  2. on_way_to_pickup_point — курьер везёт заказ в пункт выдачи.
  3. in_pickup_point — отправление приняли в пункте выдачи.
  4. delivered — покупатель забрал заказ из пункта выдачи.

Чтобы проверить статус отправления, используйте метод /v3/posting/fbs/list.

Отменить доставку отправления

  1. Используйте /v2/posting/fbs/cancel-reason/list на любом этапе работы с отправлением, чтобы получить список причин отмены отправления.

  2. Передайте этот список и номер отправления: /v2/posting/fbs/cancel.

Чтобы отменить часть товаров в отправлении, используйте /v2/posting/fbs/product/cancel.

Если отправление отменит покупатель, статус изменится на cancelled.

Схема rFBS с интегрированной службой доставки

  1. Перед началом работы с отправлениями получите список необработанных заказов (отправлений): /v3/posting/fbs/unfulfilled/list.

    Если покупатель юридическое лицо, то в блоке requirements будет информация о необходимости передать страну-производителя для всех товаров в заказе, у которых она не указана. Получите список доступных для выбора стран: /v2/posting/fbs/product/country/list. Затем передайте информацию о стране-производителе: /v2/posting/fbs/product/country/set.

    Также можно получать список заказов (отправлений): /v3/posting/fbs/list. Он позволяет получить все заказы, используя фильтры с различными статусами. Можно также получить данные аналитики, если поле with отправить со значением analytics_data.

    Отправления могут прийти в статусах awaiting_packaging, awaiting_approve или awaiting_verification.

  2. Получите дополнительную информацию о заказах: /v3/posting/fbs/get.

    В блоке requirements указывается:

    • какие товары подлежат обязательной маркировке;
    • нужно ли передать номер грузовой таможенной декларации и регистрационный номер партии товара — эту информацию также можно получить с помощью методов /v3/posting/fbs/list и /v3/posting/fbs/unfulfilled/list.

    Дополнительную информацию вы также можете получить по штрихкоду: /v2/posting/fbs/get-by-barcode.

  3. Проверьте, что коды маркировки соответствуют требованиям системы «Честный ЗНАК» по составу и количеству символов: /v4/fbs/posting/product/exemplar/validate.

    С помощью метода /v5/fbs/posting/product/exemplar/set добавьте для каждого экземпляра маркировку, которую будете передавать в систему «Честный ЗНАК». При необходимости передайте номера таможенных деклараций и регистрационные номера партии товара или укажите, что их нет.

    Подробнее о маркировке «Честный ЗНАК» в Базе знаний

    Получите статусы передачи маркировок:

  1. До окончания времени на сборку подтвердите, что вы собрали заказ: /v4/posting/fbs/ship. Вы не сможете собрать заказ, если:

    • заказ не в статусе awaiting_packaging;
    • вы не указали коды маркировки для товаров, подлежащих обязательной маркировке.

    При необходимости используйте этот метод, чтобы разделить заказ на несколько отправлений. Например, если в заказе несколько товаров и их необходимо упаковать в разные коробки, так как вместе они не отвечают требованиям к упаковке.

    После использования метода статус отправления изменится на awaiting_deliver.

    Вы можете использовать метод для частичной сборки: /v4/posting/fbs/ship/package.

Передайте отправление в службу доставки. Все статусы от «Доставляется» до «Доставлено» будет передавать служба доставки.

Отменить доставку отправления

  1. Используйте /v2/posting/fbs/cancel-reason/list на любом этапе работы с отправлением, чтобы получить список причин отмены отправления.

  2. Передайте этот список и номер отправления: /v2/posting/fbs/cancel.

Чтобы отменить часть товаров в отправлении, используйте /v2/posting/fbs/product/cancel.

Если отправление отменит покупатель, статус изменится на cancelled.

Схема rFBS Агрегатор

  1. Перед началом работы с отправлениями получите список необработанных заказов (отправлений): /v3/posting/fbs/unfulfilled/list.

    Если покупатель юридическое лицо, то в блоке requirements будет информация о необходимости передать страну-производителя для всех товаров в заказе, у которых она не указана. Получите список доступных для выбора стран: /v2/posting/fbs/product/country/list. Затем передайте информацию о стране-производителе: /v2/posting/fbs/product/country/set.

    Также можно получать список заказов (отправлений): /v3/posting/fbs/list. Он позволяет получить все заказы, используя фильтры с различными статусами. Можно также получить данные аналитики, если поле with отправить со значением analytics_data.

    Отправления могут прийти в статусах awaiting_packaging, awaiting_approve или awaiting_verification.

  2. Получите дополнительную информацию о заказах: /v3/posting/fbs/get.

    В блоке requirements указывается:

    • какие товары подлежат обязательной маркировке;
    • нужно ли передать номер грузовой таможенной декларации и регистрационный номер партии товара — эту информацию также можно получить с помощью методов /v3/posting/fbs/list и /v3/posting/fbs/unfulfilled/list.

    Дополнительную информацию вы также можете получить по штрихкоду: /v2/posting/fbs/get-by-barcode.

  3. Проверьте, что коды маркировки соответствуют требованиям системы «Честный ЗНАК» по составу и количеству символов: /v4/fbs/posting/product/exemplar/validate.

    С помощью метода /v5/fbs/posting/product/exemplar/set добавьте для каждого экземпляра маркировку, которую будете передавать в систему «Честный ЗНАК». При необходимости передайте номера таможенных деклараций и регистрационные номера партии товара или укажите, что их нет.

    Подробнее о маркировке «Честный ЗНАК» в Базе знаний

    Получите статусы передачи маркировок:

  1. Если товар в отправлении упакован в несколько коробок, передайте их количество: /v3/posting/multiboxqty/set. Если не сделать этого до сборки, вам придётся объединить все коробки в одну.

  2. До окончания времени на сборку подтвердите, что вы собрали заказ: /v4/posting/fbs/ship. Вы не сможете собрать заказ, если:

    • заказ не в статусе awaiting_packaging;
    • вы не указали коды маркировки для товаров, подлежащих обязательной маркировке.

    При необходимости используйте этот метод, чтобы разделить заказ на несколько отправлений. Например, если в заказе несколько товаров и их необходимо упаковать в разные коробки, так как вместе они не отвечают требованиям к упаковке.

    После использования метода статус отправления изменится на awaiting_registration.

    Вы можете использовать метод для частичной сборки: /v4/posting/fbs/ship/package.

  3. Когда перевозчик обработает отправление, его статус изменится с awaiting_registration на awaiting_delivery. После этого отправлению будет присвоен трек-номер.

    Для каждого отправления распечатайте этикетку для идентификации в системе Ozon: /v2/posting/fbs/package-label.

    Передайте отправление в службу доставки. Все статусы от «Доставляется» до «Доставлено» будет передавать служба доставки.

Если вы продаёте из Турции и вам нужны декларации Elektronik Ticaret Gümrük Beyannamesi (ETGB) для возврата налоговой пошлины, получите декларации: /v1/posting/global/etgb.

Отменить доставку отправления

  1. Используйте /v2/posting/fbs/cancel-reason/list на любом этапе работы с отправлением, чтобы получить список причин отмены отправления.

  2. Передайте этот список и номер отправления: /v2/posting/fbs/cancel.

Чтобы отменить часть товаров в отправлении, используйте /v2/posting/fbs/product/cancel.

Если отправление отменит покупатель, статус изменится на cancelled.

Схема rFBS Crossborder

  1. Перед началом работы с отправлениями получите список необработанных заказов (отправлений): /v3/posting/fbs/unfulfilled/list.

    Если покупатель юридическое лицо, то в блоке requirements будет информация о необходимости передать страну-производителя для всех товаров в заказе, у которых она не указана.
    Получите список доступных для выбора стран: /v2/posting/fbs/product/country/list. Затем передайте информацию о стране-производителе: /v2/posting/fbs/product/country/set.

    Также можно получать список заказов (отправлений): /v3/posting/fbs/list. Он позволяет получить все заказы, используя фильтры с различными статусами. Можно также получить данные аналитики, если поле with отправить со значением analytics_data.

    Отправления могут прийти в статусах awaiting_packaging, awaiting_approve или awaiting_verification.

    Если в параметре available_actions указано set_cutoff, уточните дату отгрузки отправления с помощью метода /v1/posting/cutoff/set. Сделайте это не позднее даты, которая указана в параметре shipment_date в методах: /v3/posting/fbs/unfulfilled/list, /v3/posting/fbs/list или /v3/posting/fbs/get. После даты shipment_date уточнить дату отгрузки и собрать отправление не получится.

  2. Получите дополнительную информацию о заказах: /v3/posting/fbs/get.

    В блоке requirements указывается:

    • какие товары подлежат обязательной маркировке;
    • нужно ли передать номер грузовой таможенной декларации и регистрационный номер партии товара — эту информацию также можно получить с помощью методов /v3/posting/fbs/list и /v3/posting/fbs/unfulfilled/list.

    Дополнительную информацию вы также можете получить по штрихкоду: /v2/posting/fbs/get-by-barcode.

  3. Проверьте, что коды маркировки соответствуют требованиям системы «Честный ЗНАК» по составу и количеству символов: /v4/fbs/posting/product/exemplar/validate.

    С помощью метода /v5/fbs/posting/product/exemplar/set добавьте для каждого экземпляра маркировку, которую будете передавать в систему «Честный ЗНАК». При необходимости передайте номера таможенных деклараций и регистрационные номера партии товара или укажите, что их нет.

    Подробнее о маркировке «Честный ЗНАК» в Базе знаний

    Получите статусы передачи маркировок:

  1. До окончания времени на сборку подтвердите, что вы собрали заказ: /v4/posting/fbs/ship. Вы не сможете собрать заказ, если:

    • заказ не в статусе awaiting_packaging;
    • вы не указали коды маркировки для товаров, подлежащих обязательной маркировке.

    При необходимости используйте этот метод, чтобы разделить заказ на несколько отправлений. Например, если в заказе несколько товаров и их необходимо упаковать в разные коробки, так как вместе они не отвечают требованиям к упаковке.

    После использования метода статус отправления изменится на awaiting_deliver.

    Вы можете использовать метод для частичной сборки: /v4/posting/fbs/ship/package.

  2. Если в настройках метода доставки вы задали временной промежуток для передачи отправления в службу доставки, измените статус отправления на sent_by_seller — «Отправлено продавцом»: /v2/fbs/posting/sent-by-seller.

  3. После передачи отправления в службу доставки измените статус отправления на delivering — «Доставляется»: /v2/fbs/posting/delivering.

  4. Одновременно с этим, если у отправления есть трек-номер, передайте его: /v2/fbs/posting/tracking-number/set.

  5. Когда курьер едет к покупателю, поменяйте статус отправления на «Последняя миля»: /v2/fbs/posting/last-mile.

  6. Когда курьер передал отправление покупателю, поменяйте статус на «Доставлено»: /v2/fbs/posting/delivered.

Схема rFBS Crossborder с интегрированной службой доставки

  1. Перед началом работы с отправлениями получите список необработанных заказов (отправлений): /v3/posting/fbs/unfulfilled/list.

    Если покупатель юридическое лицо, то в блоке requirements будет информация о необходимости передать страну-производителя для всех товаров в заказе, у которых она не указана.
    Получите список доступных для выбора стран: /v2/posting/fbs/product/country/list. Затем передайте информацию о стране-производителе: /v2/posting/fbs/product/country/set.

    Также можно получать список заказов (отправлений): /v3/posting/fbs/list. Он позволяет получить все заказы, используя фильтры с различными статусами. Можно также получить данные аналитики, если поле with отправить со значением analytics_data.

    Отправления могут прийти в статусах awaiting_packaging, awaiting_approve или awaiting_verification.

  2. Получите дополнительную информацию о заказах: /v3/posting/fbs/get.

    В блоке requirements указывается:

    • какие товары подлежат обязательной маркировке;
    • нужно ли передать номер грузовой таможенной декларации и регистрационный номер партии товара — эту информацию также можно получить с помощью методов /v3/posting/fbs/list и /v3/posting/fbs/unfulfilled/list.

    Дополнительную информацию вы также можете получить по штрихкоду: /v2/posting/fbs/get-by-barcode.

  3. Проверьте, что коды маркировки соответствуют требованиям системы «Честный ЗНАК» по составу и количеству символов: /v4/fbs/posting/product/exemplar/validate.

    С помощью метода /v5/fbs/posting/product/exemplar/set добавьте для каждого экземпляра маркировку, которую будете передавать в систему «Честный ЗНАК». При необходимости передайте номера таможенных деклараций и регистрационные номера партии товара или укажите, что их нет.

    Подробнее о маркировке «Честный ЗНАК» в Базе знаний

    Получите статусы передачи маркировок:

  1. До окончания времени на сборку подтвердите, что вы собрали заказ: /v4/posting/fbs/ship. Вы не сможете собрать заказ, если:

    • заказ не в статусе awaiting_packaging;
    • вы не указали коды маркировки для товаров, подлежащих обязательной маркировке.

    При необходимости используйте этот метод, чтобы разделить заказ на несколько отправлений. Например, если в заказе несколько товаров и их необходимо упаковать в разные коробки, так как вместе они не отвечают требованиям к упаковке.

    После использования метода статус отправления изменится на awaiting_deliver.

    Вы можете использовать метод для частичной сборки: /v4/posting/fbs/ship/package.

  2. Для каждого отправления распечатайте этикетку для идентификации в системе Ozon: /v2/posting/fbs/package-label.

  3. Если в настройках метода доставки вы задали временной промежуток для передачи отправления в службу доставки, измените статус отправления на sent_by_seller — «Отправлено продавцом»: /v2/fbs/posting/sent-by-seller.

Передайте отправление в службу доставки. Все статусы от «Доставляется» до «Доставлено» будет передавать служба доставки.

Отменить доставку отправления

  1. Используйте /v2/posting/fbs/cancel-reason/list на любом этапе работы с отправлением, чтобы получить список причин отмены отправления.

  2. Передайте этот список и номер отправления: /v2/posting/fbs/cancel.

Чтобы отменить часть товаров в отправлении, используйте /v2/posting/fbs/product/cancel.

Если отправление отменит покупатель, статус изменится на cancelled.

Как работать с заказами с весовыми товарами (rFBS)

Перед тем, как перевести заказ с весовыми товарами в статус «Ожидает отгрузки» — awaiting_delivery, передайте уточнённые данные о весе весовых товаров. Для этого после взвешивания во время сборки передайте информацию о весе каждого экземпляра каждого весового SKU через метод /v2/posting/fbs/product/change.

Товар необходимо взвешивать, если при создании товара вы указали, что товар весовой, и добавили к нему атрибуты 20577, 8933 и 8934.

После передачи корректного веса для всех экземпляров всех весовых товаров вы сможете перевести отправление в статус «Ожидает отгрузки» — awaiting_delivery.

API вернёт ошибку 400, если вы:

  • взвесили не все экземпляры из отправления,
  • передали значение веса для невесового товара,
  • вес экземпляра не попал в диапазон заданный атрибутами 8933 и 8934.

Работа с архивом актов


Получите информацию о возвратах товаров

/v1/returns/list — получите информацию о возвращённых товарах.

Получите возвратные отгрузки по штрихкоду

Убедитесь, что вы можете получать возвратные отгрузки по штрихкоду: /v1/return/giveout/is-enabled. Если у вас есть доступ, в параметре enabled будет указано значение true.

Чтобы получить возвратную отгрузку, запросите штрихкод:

Получите информацию и список возвратных отгрузок:

Вы можете забрать возвраты отдельно от поставки товаров. Если для проезда на склад Ozon нужен пропуск, создайте его с помощью метода /v1/return/pass/create. Для каждого проезда за возвратами нужен новый пропуск.

Для редактирования и удаления пропуска используйте методы /v1/return/pass/update и /v1/return/pass/delete.

Список всех пропусков можно получить с помощью метода /v1/pass/list.

Подробнее об оформлении пропусков

Управляйте заявками на возврат rFBS-заказов

Получите заявки и информацию о них:

Примите решение по заявке и возврату денег:

Запросите у покупателя товар для проверки и подтвердите получение товара с помощью метода /v2/returns/rfbs/receive-return.

Управляйте заявками на отмену

Получите заявки и информацию о них:

Примите решение по новой заявке на отмену — подтвердите или отклоните её:

  • /v1/conditional-cancellation/approve — подтвердите заявку на отмену rFBS. Заказ будет автоматически отменён, а деньги вернутся покупателю.
  • /v1/conditional-cancellation/reject — отклоните заявку на отмену rFBS. Заказ останется в том же статусе, и его нужно будет доставить покупателю.

Управляйте чатами

Для получения списка чатов используйте /v2/chat/list. В ответе будут идентификаторы текущих чатов и последних сообщений.

Для отправки сообщений по идентификатору чата используйте методы:

Для получения истории чата по идентификатору чата или сообщения используйте метод /v2/chat/history. Направление сортировки по умолчанию — от новых сообщений к старым.

Если указать идентификатор сообщения, то история начнётся с этого сообщения.

Чтобы создать новый чат с покупателем по номеру отправления, воспользуйтесь /v1/chat/start.

Чтобы отметить сообщение и все сообщения до него прочитанными, используйте /v2/chat/read.

Создайте и получите отчёты

При запросе любого из отчётов сначала возвращается код на создание документа. Отправьте его в запросе метода /v1/report/info — в ответе вернётся файл отчёта и дополнительная информация.

Чтобы получить список сформированных ранее отчётов, используйте /v1/report/list.

Методы для получения отчётов:

Получите аналитические отчёты

  • /v1/analytics/data — получите данные аналитики.

    Если укажете период и метрики, которые нужно рассчитать, в ответе будет аналитиĸа, сгруппированная по параметру dimensions.

  • /v1/analytics/stocks — получите аналитику по остаткам товаров на складах.

Чтобы получить отчёт по оборачиваемости FBO, запросите его в личном кабинете.

Получите финансовые отчёты

  • /v3/finance/transaction/list — получите подробную информацию по транзакциям для отправления.

  • /v3/finance/transaction/totals — получите детальную информацию по итоговым суммам транзакций за указанный период.

Получите информацию о рейтинге

  • /v1/rating/summary — получите текущие значения рейтингов продавца.

  • /v1/rating/history — получите информацию о рейтингах продавца за период и количество штрафных баллов, начисленных в Premium-программе.

Обновления


6 мая 2025

Метод Что изменилось
/v1/product/import/stocks Метод будет отключён 27 мая 2025 года. Переключитесь на /v2/products/stocks.
/v3/product/import Добавили параметр items.promotions в запрос метода.

30 апреля 2025

Метод Что изменилось
/v2/conditional-cancellation/approve Добавили бета-метод для подтверждения заявки на отмену rFBS-заказов.
/v2/conditional-cancellation/list Добавили бета-метод для получения списка заявок на отмену rFBS-заказов.
/v2/conditional-cancellation/reject Добавили бета-метод для отклонения заявки на отмену rFBS-заказов.

28 апреля 2025

Метод Что изменилось
/v3/product/import Удалили параметры items.image_group_id и items.premium_price из запроса метода.
/v1/product/import/info Удалили параметр result.items.errors.optional_description_elements из ответа метода.
/v1/product/import-by-sku Удалили параметр items.premium_price из запроса метода.
/v3/posting/fbs/list
/v3/posting/fbs/unfulfilled/list
Удалили параметры result.postings.financial_data.products.client_price, result.postings.financial_data.products.picking и result.postings.products.mandatory_mark из ответа методов.
/v3/posting/fbs/get
/v2/posting/fbs/get-by-barcode
Удалили параметры result.financial_data.products.client_price, result.financial_data.products.picking и result.products.mandatory_mark из ответа методов.
/v2/posting/fbo/get
/v2/posting/fbo/list
Удалили параметры result.analytics_data.region, result.financial_data.products.client_price и result.financial_data.products.picking из ответа методов.
/v2/supply-order/get Удалили параметр orders.creation_flow из ответа метода.
/v2/analytics/stock_on_warehouses Удалили параметр result.rows.idc из ответа метода.
/v1/finance/realization Метод устарел, удалили его из документации. Используйте /v2/finance/realization.

23 апреля 2025

Метод Что изменилось
/v1/finance/compensation Добавили бета-метод для получения отчёта о компенсациях.
/v1/finance/decompensation Добавили бета-метод для получения отчёта о декомпенсациях.
/v1/report/info Обновили описание параметра report_type в ответе метода.
/v1/report/list Обновили описание параметра report_type в ответе и запросе метода.

17 апреля 2025

Метод Что изменилось
/v1/finance/realization/posting Добавили бета-метод для получения позаказного отчёта о реализации товаров.

16 апреля 2025

Метод Что изменилось
/v1/analytics/manage/stocks Обновили описание параметра filter.stock_types в запросе метода.

11 апреля 2025

Метод Что изменилось
/v2/posting/fbo/get
/v2/posting/fbo/list
/v3/posting/fbs/get
/v2/posting/fbs/get-by-barcode
Удалили устаревшие параметры result.financial_data.posting_services и result.financial_data.products.item_services из ответа методов.
/v3/posting/fbs/list
/v3/posting/fbs/unfulfilled/list
Удалили устаревшие параметры result.postings.financial_data.posting_services и result.postings.financial_data.products.item_services из ответа методов.

10 апреля 2025

Метод Что изменилось
/v1/finance/realization/by-day Добавили бета-метод для получения отчёта о реализации товаров за день.

9 апреля 2025

Метод Что изменилось
/v1/analytics/stocks Добавили метод для получения аналитики по остаткам на складах.

4 апреля 2025

Метод Что изменилось
/v5/product/info/prices Добавили параметр items.price.auto_add_to_ozon_actions_list_enabled в ответ метода.

3 апреля 2025

Метод Что изменилось
/v1/product/import/prices Добавили параметр prices.auto_add_to_ozon_actions_list_enabled в запрос метода. Обновили описание параметра prices.auto_action_enabled в запросе метода.

1 апреля 2025

Метод Что изменилось
/v1/cluster/list Удалили параметр clusters.logistic_clusters.is_archived из ответа метода.

31 марта 2025

Метод Что изменилось
/v1/carriage/create
/v1/carriage/approve
/v1/carriage/delivery/list
Перенесли метод из бета-раздела в основной.

27 марта 2025

Метод Что изменилось
/v3/posting/fbs/unfulfilled/list
/v3/posting/fbs/list
/v3/posting/fbs/get
Добавили параметр is_blr_traceable в ответы методов.
/v2/supply-order/get Добавили параметры is_traceable и is_ettn_required в ответ метода.
/v1/supply-order/bundle Добавили параметр item_tags_calculation в запрос метода и параметр tags в ответ метода.

26 марта 2025

Метод Что изменилось
/v1/product/info/wrong-volume Добавили бета-метод для получения списка товаров с некорректными объёмно-весовыми характеристиками.

20 марта 2025

Метод Что изменилось
/v1/rating/summary Добавили параметр premium_plus в ответ метода.
/v1/analytics/product-queries/details Обновили описание параметров limit_by_sku, page и page_size в запросе метода.

19 марта 2025

Метод Что изменилось
/v1/product/import/info Обновили описание метода.
Добавили возможное значение skipped параметра result.items.status в ответе метода.
/v1/description-category/attribute Добавили параметр result.complex_is_collection в ответ метода.

14 марта 2025

Метод Что изменилось
/v1/analytics/product-queries/details Добавили метод для получения данных по запросам конкретного товара.

13 марта 2025

Метод Что изменилось
/v1/actions/candidates
/v1/actions/products
Пометили параметр offset в запросе методов как устаревший и добавили параметр пагинации last_id.

11 марта 2025

Метод Что изменилось
/v3/chat/history Добавили новую версию метода для просмотра истории чата.
/v1/actions/hotsales/activate
/v1/actions/hotsales/deactivate
/v1/actions/hotsales/list
/v1/actions/hotsales/products
Методы устарели, удалили их из документации.

10 марта 2025

Метод Что изменилось
/v2/product/info Метод устарел, удалили его из документации. Используйте /v3/product/info/list.

5 марта 2025

Метод Что изменилось
/v2/report/returns/create Добавили параметр result в ответ метода.
Пометили обязательными параметры filter.date_from, filter.date_to и filter.status в запросе метода.

3 марта 2025

Метод Что изменилось
/v3/posting/fbs/get В ответе метода:
• добавили параметр result.optional.products_with_possible_mandatory_mark,
• пометили устаревшим параметр result.products.mandatory_mark.
/v3/posting/fbs/list
/v3/posting/fbs/unfulfilled/list
В ответе методов:
• добавили параметр result.postings.optional.products_with_possible_mandatory_mark,
• пометили устаревшим параметр result.postings.products.mandatory_mark.
/v3/posting/fbs/get
/v3/posting/fbs/list
/v3/posting/fbs/unfulfilled/list
Значения кодов маркировки можно получить через метод /v3/posting/fbs/get c with.product_exemplars: true в запросе или метод /v6/fbs/posting/product/exemplar/create-or-get.

28 февраля 2025

Метод Что изменилось
/v4/product/info/attributes Добавили возможные значения параметра sort_by в запросе метода и добавили описания параметров result.barcodes и result.sku в ответ метода.
v2/supply-order/get Пометили параметр creation_flow как устаревший.

27 февраля 2025

Метод Что изменилось
/v2/analytics/stock_on_warehouses Обновили описание метода и отметили параметр result.rows.idc как устаревший, удалили его из примера.
/v1/warehouse/list
/v1/actions
Обновили описание метода.
/v3/posting/fbs/get Добавили параметр result.previous_substatus в ответ метода.
/v3/finance/transaction/list Обновили описание параметра result.operations.posting.delivery_schema в ответе метода.
/v1/analytics/product-queries Добавили бета-метод для получения данных о запросах ваших товаров.

26 февраля 2025

Метод Что изменилось
/v3/posting/fbs/unfulfilled/list
/v3/posting/fbs/list
Обновили описание параметра result.postings.analytics_data.city в ответе методов.
/v3/posting/fbs/get
/v2/posting/fbo/list
/v2/posting/fbo/get
Обновили описание параметра result.analytics_data.city в ответе методов.

24 февраля 2025

Метод Что изменилось
/v1/product/import/prices Добавили параметр prices.net_price в запрос метода для указания себестоимости товара.

18 февраля 2025

Метод Что изменилось
/v5/product/info/prices Перенесли метод из бета-раздела в основной.
/v4/product/info/prices Метод устарел, удалили его из документации.
/v3/returns/company/fbo
/v3/returns/company/fbs
Методы устарели, удалили их из документации. Переключитесь на новую версию /v1/returns/list.
/v1/report/returns/create Метод устарел, удалили его из документации. Переключитесь на новую версию /v2/report/returns/create.

17 февраля 2025

Метод Что изменилось
/v2/product/info/list Метод устарел, удалили его из документации. Переключитесь на новую версию /v3/product/info/list.
/v6/fbs/posting/product/exemplar/set
/v6/fbs/posting/product/exemplar/create-or-get
/v5/fbs/posting/product/exemplar/status
/v5/fbs/posting/product/exemplar/validate
/v1/fbs/posting/product/exemplar/update
Добавили бета-методы для управления кодами маркировки.

14 февраля 2025

Метод Что изменилось
v2/supply-order/get Добавили параметры orders.can_cancel, orders.is_econom, orders.is_virtual, orders.is_super_fbo, orders.product_super_fbo, orders.supplies.supply_state, orders.supplies.supply_tags.is_evsd_required, orders.supplies.supply_tags.is_jewelry, orders.supplies.supply_tags.is_marking_possible, orders.supplies.supply_tags.is_marking_required в ответ метода.
/v2/product/certification/list Перенесли метод из бета-раздела в основной.
/v1/product/certification/list Метод устаревает и будет отключён 14 апреля 2025 года. Переключитесь на новую версию /v2/product/certification/list.

11 февраля 2025

Метод Что изменилось
/v3/product/list Перенесли метод из бета-раздела в основной.
/v2/product/list Метод устарел, удалили его из документации.

10 февраля 2025

Метод Что изменилось
/v4/product/info/stocks Перенесли метод из бета-раздела в основной.
/v3/product/info/stocks Метод устарел, удалили его из документации.
/v1/product/pictures/info Метод устарел, удалили его из документации. Переключитесь на новую версию /v2/product/pictures/info.
/v3/product/info/attributes Метод устарел, удалили его из документации. Переключитесь на новую версию /v4/product/info/attributes.

6 февраля 2025

Метод Что изменилось
/v2/posting/fbs/awaiting-delivery Обновили описание параметра posting_number в запросе метода.
/v4/product/info/attributes
/v1/finance/document-b2b-sales
/v1/finance/mutual-settlement
Перенесли методы из бета-раздела в основной.

30 января 2025

Метод Что изменилось
/v1/supply-order/cancel Добавили бета-метод для отмены заявки на поставку.
/v1/supply-order/cancel/status Добавили бета-метод для получения статуса отмены заявки на поставку.

22 января 2025

Метод Что изменилось
/v3/product/info/list Перенесли метод из бета-раздела в основной.

17 января 2025

Метод Что изменилось
/v1/posting/fbs/pick-up-code/verify Добавили метод для проверки кода курьера.
/v3/posting/fbs/list
/v3/posting/fbs/unfulfilled/list
Добавили параметр result.postings.pickup_code_verified_at в ответы методов.
/v3/posting/fbs/get Добавили параметр result.pickup_code_verified_at в ответ метода.

15 января 2025

Метод Что изменилось
/v1/product/import/prices Добавили параметр prices.min_price_for_auto_actions_enabled в запрос метода.
/v1/product/action/timer/update Добавили бета-метод для обновления таймера актуальности минимальной цены.
/v1/product/action/timer/status Добавили бета-метод для получения статуса установленного таймера.

14 января 2025

Метод Что изменилось
/v1/returns/list Обновили описание параметров filter и filter.posting_numbers в запросе метода.
/v2/product/pictures/info Перенесли метод из бета-раздела в основной.

13 января 2025

Метод Что изменилось
/v2/posting/fbs/digital/act/document-sign Метод устарел, удалили его из документации.

28 декабря 2024

Метод Что изменилось
/v1/supply-order/bundle Добавили описание метода, изменили описания параметров bundle_ids, last_id и limit в запросе метода.
/v1/warehouse/fbo/list Изменили название и описание метода, изменили описание параметра search в запросе метода.
/v1/draft/create/info Обновили описание параметров clusters.warehouses.bundle_ids.bundle_id и clusters.warehouses.restricted_bundle_id в ответе метода.
/v1/cluster/list Обновили описание параметра cluster_type в запросе метода.
/v1/warehouse/fbo/list Обновили описание параметра filter_by_supply_type в запросе метода.
/v1/question/answer/create
/v1/question/answer/delete
/v1/question/answer/list
/v1/question/change-status
/v1/question/count
/v1/question/info
/v1/question/list
/v1/question/top-sku
Добавили бета-методы для работы с вопросами и ответами.

27 декабря 2024

Метод Что изменилось
/v1/review/comment/create
/v1/review/comment/delete
/v1/review/comment/list
/v1/review/change-status
/v1/review/count
/v1/review/info
/v1/review/list
Добавили бета-методы для работы с отзывами.
/v1/carriage/create Добавили бета-метод для создания отгрузки.
/v1/carriage/approve Добавили бета-метод для подтверждения отгрузки.
/v1/carriage/delivery/list Добавили бета-метод для получения списка методов доставки и отгрузок.
/v1/carriage/get Добавили параметры result.is_waybill_enabled и result.is_econom в ответ метода.

26 декабря 2024

Метод Что изменилось
/v1/delivery-method/list Добавили параметр result.sla_cut_in в ответ метода.
/v1/supply-order/get Метод устарел, удалили его из документации. Используйте /v2/supply-order/get.
/v1/supply-order/list Метод устарел, удалили его из документации. Используйте /v2/supply-order/list.
/v1/supply-order/items Метод устарел, удалили его из документации. Используйте /v1/supply-order/bundle.
/v4/product/info/prices Метод устаревает и будет отключён 17 февраля 2025 года. Переключитесь на новую версию /v5/product/info/prices.
/v3/product/info/list Добавили параметр items.is_super в ответ метода.

24 декабря 2024

Метод Что изменилось
/v1/product/import/prices Добавили параметр prices.vat в запрос метода.
/v1/product/import-by-sku
/v3/product/import
Обновили описание параметра items.vat в запросе методов.

20 декабря 2024

Метод Что изменилось
/v2/report/returns/create
/v1/posting/unpaid-legal/product/list
Перенесли методы из бета-раздела в основной.
/v1/report/returns/create Метод устаревает и будет отключён 15 февраля 2025 года. Переключитесь на новую версию /v2/report/returns/create.
/v3/returns/company/fbo
/v3/returns/company/fbs
Обновили дату отключения методов.

19 декабря 2024

Метод Что изменилось
/v1/carriage/set-postings Добавили бета-метод для изменения состава отгрузки.
/v1/carriage/cancel Добавили бета-метод для удаления отгрузки.

17 декабря 2024

Метод Что изменилось
/v3/product/info/list Добавили бета-метод для получения списка товаров по идентификаторам.
/v2/product/info
/v2/product/info/list
Методы устаревают и будут отключены 17 февраля 2025 года. Переключитесь на новую версию /v3/product/info/list.
/v2/posting/fbs/act/list Пометили обязательными параметры filter.date_from и filter.date_to в запросе метода.

12 декабря 2024

Метод Что изменилось
/v1/cargoes/create
/v1/cargoes/create/info
/v1/cargoes-label/create
/v1/cargoes-label/get
/v1/cargoes-label/file/{file_guid}
Добавили бета-методы для работы с грузоместами.
В разделе Порядок работы с методами → Управляйте заказами FBO, FBS и rFBS → Схема FBO добавили информацию об управлении грузоместами в заявке на поставку.

11 декабря 2024

Метод Что изменилось
/v2/product/pictures/info Добавили бета-метод для получения изображений товаров.
/v1/product/pictures/info Метод устаревает и будет отключён 11 февраля 2025 года. Переключитесь на новую версию /v2/product/pictures/info.

9 декабря 2024

Метод Что изменилось
/v1/returns/company/fbs/info В ответе метода:
• Добавили параметры drop_off_points.box_count и drop_off_points.utc_offset.
• Удалили параметр company_id.
/v2/product/list Удалили статус BANNED из запроса метода, при его использовании будет применено поле по умолчанию. Метод устаревает и будет отключён 9 февраля 2025 года. Переключитесь на новую версию /v3/product/list.
/v3/finance/transaction/list Дополнили описание метода: используйте метод с последовательной отправкой запросов. Обновили описание параметров result.page_count и result.row_count в ответе метода.
/v3/product/info/attributes Метод устаревает и будет отключён 9 февраля 2025 года. Переключитесь на новую версию /v4/product/info/attributes.
/v1/returns/list Добавили параметр returns.product.quantity в ответ метода.

6 декабря 2024

Метод Что изменилось
/v2/product/certification/list Добавили бета-метод для получения списка сертифицируемых категорий.

4 декабря 2024

Метод Что изменилось
/v4/product/info/stocks Добавили бета-метод для получения информации о количестве товара.
/v3/product/info/stocks Метод устаревает и будет отключён 31 января 2025 года. Переключитесь на новую версию /v4/product/info/stocks.

3 декабря 2024

Метод Что изменилось
/v2/finance/realization Добавили параметры result.rows.return_commission.bank_coinvestment, result.rows.delivery_commission.pick_up_point_coinvestment и result.rows.return_commission.pick_up_point_coinvestment в ответ метода.

29 ноября 2024

Метод Что изменилось
/v3/posting/fbs/unfulfilled/list
/v3/posting/fbs/list
Обновили описание параметров result.postings.analytics_data.city и result.postings.analytics_data.region в ответе методов.
/v3/posting/fbs/get Обновили описание параметров result.analytics_data.city и result.analytics_data.region в ответе метода.
/v2/posting/fbo/list
/v2/posting/fbo/get
Параметры result.analytics_data.city и result.analytics_data.region в ответе методов устаревают и будут всегда возвращать пустое значение.

26 ноября 2024

Метод Что изменилось
/v1/analytics/turnover/stocks Перенесли метод из бета-раздела в основной.

22 ноября 2024

Метод Что изменилось
/v2/report/returns/create Добавили бета-метод для получения отчёта о возвратах FBO и FBS.
/v1/report/info Добавили статус SELLER_RETURNS_V2 в параметр report_type.
/v1/posting/fbs/split Перенесли метод из бета-раздела в основной.

20 ноября 2024

Метод Что изменилось
/v1/posting/unpaid-legal/product/list Добавили бета-метод для получения списка неоплаченных товаров, заказанных юридическими лицами.

19 ноября 2024

Метод Что изменилось
/v1/product/import-by-sku Обновили название и описание метода, обновили описание параметра items в запросе метода.

18 ноября 2024

Метод Что изменилось
/v1/analytics/manage/stocks Добавили бета-метод для управления остатками на складах.

14 ноября 2024

Метод Что изменилось
/v1/product/import/prices Обновили описание метода и описание параметра prices в запросе метода.

13 ноября 2024

Метод Что изменилось
/v3/posting/fbs/unfulfilled/list
/v3/posting/fbs/list
/v3/posting/fbs/get
Добавили параметр result.postings.tariffication в ответы методов.
/v1/posting/carriage-available/list Добавили параметры result.recommended_time_local и result.recommended_time_utc_offset_in_minutes в ответ метода.

7 ноября 2024

Метод Что изменилось
/v1/report/list Добавили статусы DOCUMENT_B2B_SALES и MUTUAL_SETTLEMENT в параметр запроса report_type.
/v1/report/info Добавили статусы DOCUMENT_B2B_SALES и MUTUAL_SETTLEMENT в параметр ответа result.reports.report_type.
/v3/product/import
/v2/products/stocks
/v2/posting/fbs/product/cancel
Обновили описания методов.
/v1/finance/cash-flow-statement/list В описании параметра result.details.services.items.name изменили название операции MarketplaceServiceItemPremiumSubscribtion на MarketplaceServiceItemSubscribtionPremium.
В разделе Порядок работы с методами добавили информацию об ограничении отправки запросов.

6 ноября 2024

Метод Что изменилось
/v1/cluster/list Добавили бета-метод для получения информации о кластерах.
/v1/draft/create Добавили бета-метод для создания черновика заявки на поставку.
/v1/draft/create/info Добавили бета-метод для получения информации о черновике заявки на поставку.
/v1/draft/timeslot/info Добавили бета-метод для получения доступных таймслотов для черновика заявки на поставку.
/v1/draft/supply/create Добавили бета-метод для создания заявки на поставку по черновику.
/v1/supply/create/status Добавили бета-метод для получения информации о создании заявки на поставку.
/v1/warehouse/fbo/list Добавили бета-метод для получения информации о складах для отгрузки.
/v1/finance/mutual-settlement Добавили бета-метод для получения отчёта о взаиморасчётах.
/v1/finance/document-b2b-sales Добавили бета-метод для получения отчёта о продажах юридическим лицам.
В разделе Порядок работы с методами → Управляйте заказами FBO, FBS и rFBS → Схема FBO → Создать заявку на поставку добавили информацию о создании заявки на поставку по схеме FBO.
/v1/quant/list Добавили бета-метод для получения списка квантов.
/v1/quant/get Добавили бета-метод для получения информации о кванте и его отправлениях.
/v1/quant/ship Добавили бета-метод для сборки отправлений кванта.
/v1/quant/status Добавили бета-метод для получения статуса кванта.
/v1/product/quant/info Добавили бета-метод для получения информации об эконом-товаре.
/v1/product/quant/list Добавили бета-метод для получения списка эконом-товаров.
/v1/warehouse/list Добавили параметр result.is_economy в ответ метода.
/v3/posting/fbs/unfulfilled/list
/v3/posting/fbs/list
Добавили параметры filter.is_quantum в запрос и result.postings.quantum_id в ответ методов.
/v2/product/list Добавили описание метода.
У параметра filter.visibility в запросе метода удалили возможные значения IMAGE_ABSENT и MODERATION_BLOCK.
В разделе Порядок работы с методами → Управляйте заказами FBO, FBS и rFBS → Схема FBS Стандарт → Работа с эконом-товарами добавили информацию о работе с эконом-товарами.
/v2/products/stocks Добавили параметр stocks.quant_size в запрос и result.quant_size в ответ метода.
/v1/product/import/prices Добавили параметр prices.quant_size в запрос метода.

31 октября 2024

Метод Что изменилось
/v3/returns/company/fbo
/v3/returns/company/fbs
Методы устаревают и будут отключены 28 декабря 2024 года. Переключитесь на метод /v1/returns/list.

25 октября 2024

Метод Что изменилось
/v1/product/import/info Параметр result.items.errors.optional_description_elements в ответе метода устаревает и будет всегда возвращать пустое значение.

24 октября 2024

Метод Что изменилось
/v1/posting/fbs/split Добавили бета-метод для разделения заказа на отправления без сборки.

23 октября 2024

Метод Что изменилось
/v3/returns/company/fbs Добавили статусы arrived_for_resale и moving_to_resale в параметр запроса filter.status.

22 октября 2024

Метод Что изменилось
Добавили раздел с методами, которые находятся на стадии тестирования.
/v1/analytics/turnover/stocks Добавили бета-метод для получения информации об оборачиваемости товара.

17 октября 2024

Метод Что изменилось
/v1/posting/cutoff/set Добавили метод для уточнения даты отгрузки отправления, которое доставляет неинтегрированный перевозчик или продавец.
/v3/posting/fbs/unfulfilled/list
/v3/posting/fbs/list
Добавили параметр result.postings.available_actions в ответы методов.
/v3/posting/fbs/get Добавили параметр result.available_actions в ответ метода.
Добавили информацию об указании даты отгрузки отправлений, которые доставляет неинтегрированный перевозчик или продавец по схемам rFBS Стандарт и rFBS Crossborder.
/v1/products/geo-restrictions-catalog-by-filter Удалили метод /v1/products/geo-restrictions-catalog-by-filter из документации.
/v3/product/import Обновили описание параметра items.geo_names в запросе метода.

16 октября 2024

Метод Что изменилось
/v1/returns/list Добавили метод для получения информации о возвратах FBO и FBS.
/v1/rating/summary Добавили параметр localization_index в ответ метода.

11 октября 2024

Метод Что изменилось
/v3/product/import Обновили раздел «Загрузка видео» в описании метода.

8 октября 2024

Метод Что изменилось
/v3/posting/fbs/unfulfilled/list
/v3/posting/fbs/list
Обновили описание параметров result.postings.cancellation.cancellation_type и result.postings.cancellation.cancellation_initiator в ответе метода.
/v3/posting/fbs/get Обновили описание параметров result.cancellation.cancellation_type и result.cancellation.cancellation_initiator в ответе метода.
/v1/finance/cash-flow-statement/list Обновили описание параметра result.details.services.items.name в ответе метода.
/v3/finance/transaction/list Обновили описание параметров filter.operation_type в запросе метода и result.operations.services.name в ответе метода.
/v4/posting/fbs/ship Обновили описание метода.

3 октября 2024

Метод Что изменилось
/v1/posting/fbo/cancel-reason/list Добавили метод для получения информации о причинах отмены отправлений по схеме FBO.
/v1/product/import/stocks

/v2/products/stocks
Обновили описание метода и параметра stocks.stock в запросе метода.

2 октября 2024

Метод Что изменилось
/v2/posting/fbs/product/cancel Обновили описание метода.
/v2/posting/fbs/cancel-reason/list Обновили пример ответа.

1 октября 2024

Метод Что изменилось
/v3/product/import

/v3/products/info/attributes
Параметр image_group_id устарел, удалили его из примеров кода.

20 сентября 2024

Метод Что изменилось
/v2/supply-order/get Обновили описание параметра orders.state в ответе метода.
/v2/supply-order/list Обновили описание параметра filter.states в запросе метода.
/v1/supply-order/bundle Обновили описание параметров bundle_ids и limit в запросе метода.

19 сентября 2024

Метод Что изменилось
/v1/supply-order/list
/v1/supply-order/get
Методы устаревают и будут отключены в будущем. Переключитесь на новые версии — /v2/supply-order/list и /v2/supply-order/get.
/v1/supply-order/status/counter Добавили новый метод для получения статуса заявки и количества поставок в этом статусе.
/v1/supply-order/timeslot/get
/v1/supply-order/timeslot/update
/v1/supply-order/timeslot/status
Добавили новые методы по работе с интервалами поставки.
/v1/supply-order/pass/create
/v1/supply-order/pass/status
Добавили новые методы для создания пропуска на фулфилмент и получения статуса данных.
/v1/supply-order/bundle Добавили метод для получения состава поставки или заявки на поставку.
В разделе Порядок работы с методами → Схема FBO → Получите информацию о заявках на поставку обновили порядок работы с методами по схеме FBO.

18 сентября 2024

Метод Что изменилось
/v3/finance/transaction/list Дополнили описание параметра filter.operation_type в запросе метода и result.operations.services.name в ответе метода.
/v2/finance/realization Добавили параметр result.rows.delivery_commission.bank_coinvestment в ответ метода.

6 сентября 2024

Метод Что изменилось
/v3/product/import
/v3/products/info/attributes
Добавили параметр items.type_id в запрос метода /v3/product/import и result.type_id в ответ метода /v3/products/info/attributes.
Подробнее о переходе на type_id.

28 августа 2024

Метод Что изменилось
/v2/analytics/stock_on_warehouses Добавили параметр result.rows.idc в ответ метода.

26 августа 2024

Метод Что изменилось
/v3/product/import Добавили параметр new_description_category_id в запрос метода — он используется для смены категории уже созданного товара.

9 августа 2024

Метод Что изменилось
/v1/description-category/attribute/values/search Добавили метод для поиска по справочным значениям характеристики.

8 августа 2024

Метод Что изменилось
Пуш-уведомления Описали ошибки при подключении пуш-уведомлений.

5 августа 2024

Метод Что изменилось
/v1/supply-order/list В запросе и ответе удалили статусы поставки по заявке: DRAFT, SUPPLY_VARIANTS_ARRANGING, HAS_NO_SUPPLY_VARIANTS_ARCHIVE, HAS_NO_SUPPLY_VARIANTS_NEW, SUPPLY_VARIANT_CONFIRMATION, TIMESLOT_BOOKING.
/v1/products/geo-restrictions-catalog-by-filter Метод устаревает и будет отключён 1 октября 2024.

2 августа 2024

Метод Что изменилось
Частые ошибки Обновили описание ошибки Invalid Api-Key, please contact support для метода /v2/posting/fbs/act/create.
Частые ошибки Удалили метод /v2/posting/fbs/ship из документации.
/v3/finance/transaction/list Добавили вид услуги OperationMarketplaceAgencyFeeAggregator3PLGlobal в параметр result.operations.services.name.
/v1/report/info
/v1/report/list
/v1/report/products/create
/v1/report/returns/create
/v1/report/postings/create
/v1/report/discounted/create
/v1/report/warehouse/stock
Обновили описание параметров code и file в ответах и запросах методов.
## 22 июля 2024
Метод Что изменилось
/v1/finance/cash-flow-statement/list
/v1/report/products/create
/v1/report/returns/create
/v1/report/postings/create
/v1/report/discounted/create
/v1/report/warehouse/stock
/v2/finance/realization
/v3/finance/transaction/list
/v3/finance/transaction/totals
/v1/analytics/data
/v2/analytics/stock_on_warehouses
/v1/rating/summary
/v1/rating/history
/v1/return/giveout/list
/v1/return/giveout/info
Обновили описание методов.

27 июня 2024

Метод Что изменилось
/v3/posting/fbs/list Добавили параметр filter.last_changed_status_date в запрос метода.
Частые ошибки Добавили описание ошибки GTD_MUST_BE_SPECIFIED_FOR_PRODUCT_COUNTRY для метода /v4/fbs/posting/product/exemplar/validate и NO_POSTINGS_FOR_BATCH_DOWNLOAD для метода /v2/posting/fbs/package-label.
/v2/product/info/list В параметре product_id изменили описание формата ввода данных.
/v2/posting/fbo/list
/v2/posting/fbo/get
Добавили возможные значения параметра result.analytics_data.payment_type_group_name в ответе метода.
/v3/posting/fbs/list
/v3/posting/fbs/unfulfilled/list
/v3/posting/fbs/get
Добавили возможные значения параметра result.postings.analytics_data.payment_type_group_name в ответе метода. Дополнили описание статуса cancelled_from_split_pending.
/v3/posting/fbs/get Обновили описание параметров addresse.phone, courier.phone и customer.phone в ответе метода.

18 июня 2024

Метод Что изменилось
/v3/product/import

/v1/product/import-by-sku

/v2/product/info/list

/v2/product/info

/v4/product/info/prices
Параметр premium_price устарел, удалили его из примеров кода.

10 июня 2024

Метод Что изменилось
/v3/posting/fbs/get
/v3/posting/fbs/list
/v3/posting/fbs/unfulfilled/list
Удалили параметр customer.customer_email из ответа методов.

7 июня 2024

Раздел Что изменилось
Порядок работы с методами Добавили информацию о резервировании товаров.

31 мая 2024

Метод Что изменилось
/v1/invoice/create-or-update Метод устарел, удалили его из документации. Используйте /v2/invoice/create-or-update.
/v1/invoice/get Метод устарел, удалили его из документации. Используйте /v2/invoice/get.

24 мая 2024

Метод / раздел Что изменилось
/v3/finance/transaction/list Заменили MarketplaceServiceStorageItem на OperationMarketplaceServiceStorage в параметре ответа operations.services.
/v1/product/related-sku/get Обновили описание метода.
/v2/product/info/list Обновили описание параметра items.id в ответе метода.
/v3/returns/company/fbs Обновили описание параметра returns.moving_to_place_name в ответе метода.
/v2/posting/fbo/get

/v2/posting/fbo/list

/v3/posting/fbs/unfulfilled/list

/v3/posting/fbs/get

/v3/posting/fbs/list
Пометили устаревшими параметры postings.financial_data.products.item_services и postings.financial_data.posting_services в ответе методов.
Частые ошибки Добавили описание ошибки Incorrect_density для метода /v3/product/import и Incorrect_carriage_status для /v2/posting/fbs/act/create.

23 мая 2024

Метод Что изменилось
/v2/posting/fbs/package-label/create Добавили новую версию метода для создания задания на формирование этикеток.
/v1/posting/fbs/package-label/create Метод устаревает и будет отключён в будущем. Мы предупредим вас об этом за месяц. Переключитесь на новую версию /v2/posting/fbs/package-label/create.

17 мая 2024

Метод Что изменилось
/v4/posting/fbs/ship Добавили описание ошибки EXEMPLAR_INFO_NOT_FILLED_COMPLETELY в таблице Частые ошибки.
/v3/returns/company/fbs Обновили описание параметра filter.status в запросе метода и параметра returns.product_id в ответе метода.
/v4/posting/fbs/ship/package

/v1/product/import/prices
Обновили описание метода.
/v3/product/import Изменили описание параметра items.description_category_id в примере запроса.
/v4/product/info/prices

/v3/product/import

/v2/product/info/list

/v2/product/info

/v1/product/import-by-sku
Отметили устаревшим параметр premium_price в ответах и запросах методов.
/v1/description-category/attribute/values

/v1/description-category/attribute

/v1/description-category/tree
Добавили примеры запросов и ответов.
Обновили описание уведомлений TYPE_NEW_POSTING, TYPE_POSTING_CANCELLED, TYPE_STATE_CHANGED, TYPE_CUTOFF_DATE_CHANGED, TYPE_DELIVERY_DATE_CHANGED в разделе Пуш-уведомления.

7 мая 2024

Метод Что изменилось
/v2/product/info Добавили параметры result.is_archived и result.is_autoarchived в ответ метода.
/v2/product/info/list Добавили параметры result.items.is_archived и result.items.is_autoarchived в ответ метода.
/v1/product/unarchive Метод доступен для работы. Обновили описание параметра product_id в запрос метода.

3 мая 2024

Метод Что изменилось
/v1/product/import/stocks Обновили описание метода. Метод устаревает и будет отключён в будущем. Переключитесь на новую версию — указали её в описании метода.
В разделе Частые ошибки для методов /v2/products/stocks и /v1/product/import/stocks добавили описание ошибок Fatal error: You have more than 1 FBS warehouses. Please use API Method POST /v2/products/stocks, product_is_not_created, offer_id_not_found, FLAMMABLE_ONLY_ON_SELF_OR_PROVIDER_DELIVERY и WAREHOUSE_NOT_FOUND.
/v1/product/import/stocks

/v2/products/stocks
Обновили описание параметра result.errors.code в ответе метода.

2 мая 2024

Метод Что изменилось
/v2/finance/realization Добавили новую версию метода для получения отчёта о реализации товаров.
/v1/invoice/create-or-update Метод устаревает и будет отключён 31 мая 2024 года. Переключитесь на новую версию /v2/invoice/create-or-update.
/v1/invoice/file/upload Добавили метод для загрузки счёта-фактуры.
/v1/invoice/get Метод устаревает и будет отключён 31 мая 2024 года. Переключитесь на новую версию /v2/invoice/get.

26 апреля 2024

Метод Что изменилось
В разделе Частые ошибки для методов /v4/fbs/posting/product/exemplar/set и /v5/fbs/posting/product/exemplar/set добавили описание ошибок GTD_IS_REQUIRED_ONLY_FOR_LEGAL_CUSTOMER и EXEMPLAR_ID does not belong to product PRODUCT_ID.

16 апреля 2024

Метод Что изменилось
/v3/finance/transaction/list В ответе метода дополнили описание параметра result.operations.services.name.
/v1/pricing-strategy/product/info Добавили описание метода.
/v3/product/import Дополнили описание метода информацией о загрузке видеообложек.
В разделе Частые ошибки для метода /v2/products/stocks:
• удалили описание ошибки SKU STOCK NOT CHANGED;
• добавили описание ошибки NOT_FOUND_ERROR.
Дополнили раздел Порядок работы с методами → Схема FBS Стандарт информацией о получении exemplar_id методом /v5/fbs/posting/product/exemplar/create-or-get.

9 апреля 2024

Метод / раздел Что изменилось
/v1/carriage/get Обновили описание параметра status в ответе метода.

8 апреля 2024

Метод Что изменилось
/v1/product/pictures/import

/v1/product/pictures/info
В ответе метода для поля result.pictures.state изменили статус failed на pending.

1 апреля 2024

Метод / раздел Что изменилось
/v1/carriage/get Добавили метод для получения информации о перевозке.
/v1/carriage/pass/create Добавили метод для создания пропуска.
/v1/carriage/pass/update Добавили метод для обновления пропуска.
/v1/carriage/pass/delete Добавили метод для удаления пропуска.
/v1/return/pass/create Добавили метод для создания пропуска на вывоз возвратов.
/v1/return/pass/update Добавили метод для обновления пропуска на вывоз возвратов.
/v1/return/pass/delete Добавили метод для удаления пропуска на вывоз возвратов.
/v1/pass/list Добавили метод для получения списка пропусков.
/v1/returns/company/fbs/info Добавили метод для получения информации о возвратах FBS и их количестве.
Порядок работы с методами В разделах Схема FBS Стандарт и Получите возвратные отгрузки по штрихкоду описали новые методы по работе с пропусками.
Доставка FBS Создали новый раздел, перенесли в него старые методы и добавили новый — /v1/carriage/get.
Доставка rFBS Создали новый раздел, перенесли в него старые методы.

29 марта 2024

Метод Что изменилось
/v2/product/info Параметр minValue в ответе метода устарел, удалили его из документации.
/v4/product/info/prices
/v2/product/info
Параметр recommended_price в ответе метода устарел, удалили его из документации.

22 марта 2024

Метод Что изменилось
/v3/posting/fbs/list

/v3/posting/fbs/get

/v3/posting/fbs/unfulfilled/list

/v2/posting/fbo/get

/v2/posting/fbo/list
Отметили устаревшим параметр client_price в ответе.

11 марта 2024

Метод Что изменилось
/v2/category/attribute/values Метод устарел, удалили его из документации. Используйте /v1/description-category/attribute/values.
/v2/category/tree Метод устарел, удалили его из документации. Используйте /v1/description-category/tree.
/v3/category/attribute Метод устарел, удалили его из документации. Используйте /v1/description-category/attribute.
/v2/product/import Метод устарел, удалили его из документации. Используйте /v3/product/import.
/v3/posting/fbs/unfulfilled/list Добавили значение hybryd для параметра ответа tpl_integration_type.

1 марта 2024

Метод Что изменилось
/v3/returns/company/fbs Удалили параметр accepted_from_customer_moment из запроса и ответа метода.

29 февраля 2024

Метод Что изменилось
В разделе Порядок работы с методами добавили, что для продавцов rFBS Стандарт с 11 марта 2024 года максимальный срок доставки до покупателя — 30 дней. Обновите срок в настройках вашего метода. Если срок будет больше максимального, он поменяется автоматически.

21 февраля 2024

Метод Что изменилось
/v2/category/tree
/v3/category/attribute
/v2/category/attribute/values
/v2/product/import
Методы устаревают и будут отключены 11 марта 2024 года.

20 февраля 2024

Метод Что изменилось
/v1/chat/list Метод устарел, удалили его из документации. Используйте /v2/chat/list.
/v1/chat/history
/v1/chat/updates
Методы устарели, удалили их из документации. Используйте /v2/chat/history.

16 февраля 2024

Метод Что изменилось
/v4/posting/fbs/ship/package Дополнили описание метода: по умолчанию статус созданных отправлений awaiting_deliver.
/v2/chat/history Добавили описание метода.
/v1/analytics/data Обновили описание параметра id в ответе метода.
/v5/fbs/posting/product/exemplar/create-or-get Дополнили описание метода: используйте метод для получения exemplar_id.
/v5/fbs/posting/product/exemplar/set Дополнили описание метода информацией об ответе.

13 февраля 2024

Метод Что изменилось
/v1/description-category/attribute Добавили параметр result.category_dependent в ответ метода.

9 февраля 2024

Метод Что изменилось
/v3/posting/fbs/ship Метод устарел, удалили его из документации. Используйте /v4/posting/fbs/ship.
/v3/posting/fbs/ship/package Метод устарел, удалили его из документации. Используйте /v4/posting/fbs/ship/package.

8 февраля 2024

Метод Что изменилось
/v3/returns/company/fbo Добавили параметр return_id и обновили описание параметра id в ответе метода.

26 января 2024

Метод Что изменилось
/v3/returns/company/fbo Обновили описания параметров status в запросе метода и status_name в ответе метода.

25 декабря 2023

Метод Что изменилось
/v1/description-category/attribute Добавили два параметра в ответ метода: max_value_count и attribute_complex_id.
/v3/product/import Добавили новую версию метода для загрузки и обновления товаров.
/v2/product/info
/v2/product/info/list
Добавили параметр type_id в ответ методов.
/v1/description-category/tree
/v1/description-category/attribute
/v1/description-category/attribute/values
Изменили параметр category_id на description_category_id в запрос и ответ методов.

15 декабря 2023

Метод Что изменилось
/v1/chat/list Дополнили значение параметра page_size в запросе метода. Метод устаревает и будет отключён в будущем. Переключитесь на новую версию — указали её в описании метода.
/v1/chat/history Обновили значения параметра limit в запросе метода. Метод устаревает и будет отключён в будущем. Переключитесь на новую версию — указали её в описании метода.
/v2/chat/list
/v2/chat/history
Дополнили значения параметра limit в запросах методов.
/v1/chat/updates Дополнили значения параметра limit в запросах методов. Метод устаревает и будет отключён в будущем. Переключитесь на альтернативную версию — указали её в описании метода.

12 декабря 2023

Метод Что изменилось
/v2/posting/fbo/list Дополнили описание метода: если период больше года, вернётся ошибка PERIOD_IS_TOO_LONG. Обновили описание параметра offset в запросе метода.
/v3/products/info/attributes Добавили описание параметра images.default в ответе метода.
/v3/posting/fbs/unfulfilled/list Из описания метода убрали статус delivered и добавили информацию о получении актуальной даты отгрузки.
/v1/finance/cash-flow-statement/list Дополнили значения параметра items.name в ответе метода.
/v2/product/info/list Из описания метода убрали информацию о совпадении полей в параметре items с методом /v2/product/info.
/v3/posting/fbs/list
/v3/posting/fbs/get
Обновили описание метода: добавили информацию о получении актуальной даты отгрузки.
/v2/posting/fbs/cancel Обновили описание метода: убрали идентификаторы причин отмены и добавили информацию о проверке статуса отмены для отправления.
/v3/finance/transaction/list Дополнили значения параметра filter.operation_type в запросе метода.
/v1/product/import/prices Обновили описание метода: добавили информацию об ошибке action_price_enabled_min_price_missing.
/v3/finance/transaction/totals Дополнили описание метода: если номера отправлений заполнены неправильно, в ответе вернутся нулевые значения.
/v1/product/import/stocks Обновили описание метода: задать наличие товара возможно только после того, как его статус сменится на price_sent.
/v1/report/info Обновили описание параметра result.file в ответе метода.

7 декабря 2023

Метод Что изменилось
/v2/posting/fbs/package-label Обновили описание метода: убрали информацию, что при работе по схеме rFBS не нужно печатать этикетки.

1 декабря 2023

Метод Что изменилось
/v5/fbs/posting/product/exemplar/set Добавили новую версию метода для проверки и сохранения данных экземпляров.
/v5/fbs/posting/product/exemplar/create-or-get Добавили метод для получения данных о созданных экземплярах.
/v4/posting/fbs/ship/package Добавили новую версию метода для частичной сборки отправления.
/v4/fbs/posting/product/exemplar/status
/v3/posting/fbs/get
Добавили параметр exemplars.exemplar_id в ответы методов.

30 ноября 2023

Метод Что изменилось
/v2/returns/rfbs/list Добавили метод для получения заявок на возврат rFBS-заказов.
/v2/returns/rfbs/get Добавили метод для получения информации о заявке на возврат rFBS-заказа.
/v2/returns/rfbs/reject Добавили метод для отклонения заявки на возврат rFBS-заказа.
/v2/returns/rfbs/compensate Добавили метод для частичной компенсации стоимости товара в rFBS-заказе.
/v2/returns/rfbs/verify Добавили метод для одобрения заявки на возврат rFBS-заказа.
/v2/returns/rfbs/receive-return Добавили метод для подтверждения, что товар получили для проверки.
/v2/returns/rfbs/return-money Добавили метод для возврата полной стоимости товара в rFBS-заказе.
В раздел Порядок работы с методами добавили подраздел Управляйте заявками на возврат rFBS-заказов.

29 ноября 2023

Метод Что изменилось
/v1/return/giveout/is-enabled Добавили метод для проверки возможности получения возвратных отгрузок по штрихкоду.
/v1/return/giveout/get-pdf
/v1/return/giveout/get-png
Добавили методы для получения штрихкода возвратной отгрузки в формате PDF и PNG.
/v1/return/giveout/barcode Добавили метод для получения штрихкода возвратной отгрузки в текстовом виде.
/v1/return/giveout/barcode-reset Добавили метод для обновления штрихкода возвратной отгрузки.
/v1/return/giveout/list Добавили метод для получения списка возвратных отгрузок.
/v1/return/giveout/info Добавили метод для получения информации о возвратных отгрузках.

8 ноября 2023

Метод Что изменилось
v3/posting/fbs/list Обновили пример запроса.
/v3/finance/transaction/list Дополнили описание параметра result.operations.services.name в ответе метода: добавили услугу drop-off в пункте приёма заказов.
/v2/product/info
/v2/product/info/list
Дополнили описание метода: параметр active_product устарел, используйте значение параметра visible.
/v1/report/warehouse/stock Обновили описание метода: он возвращает остатки только для FBS-складов.
/v2/products/stocks Обновили описание метода: задать наличие товара возможно только после того, как его статус сменится на price_sent.

30 октября 2023

Метод Что изменилось
/v1/report/postings/create Обновили описание параметра delivery_schema в запросе метода и пример запроса.

26 октября 2023

Метод Что изменилось
/v1/product/related-sku/get Добавили метод для получения связанных SKU.

19 октября 2023

Метод Что изменилось
/v3/product/info/stocks Обновили пример ответа. Теперь метод возвращает остатки товаров по всем схемам работы — FBO, FBS и Crossborder, даже если вы не работаете по каким-то из них.
/v1/report/info Добавили описания статусов waiting и processing в параметр status их ответа метода.
/v3/posting/fbs/ship Метод устаревает и будет отключён в будущем. Переключитесь на новую версию — указали её в описании метода.

18 октября 2023

Метод Что изменилось
/v1/report/warehouse/stock Добавили метод для формирования отчёта об остатках на складе.
/v1/report/list Добавили в ответ метода, в течение какого времени доступна ссылка для получения отчёта с report_type="SELLER_RETURNS".
/v1/report/returns/create В ответ метода добавили, в течение какого срока можно получить отчёт по идентификатору.
/v1/report/stock/create Метод устарел, удалили его из документации. Используйте /v1/report/warehouse/stock.
/v1/report/discounted/info Метод устарел, удалили его из документации. Чтобы получить отчёт об уценённых товарах, запустите формирование через /v1/report/discounted/create и получите его через /v1/report/info.
/v1/report/discounted/list Метод устарел, удалили его из документации. Чтобы получить список отчётов об уценённых товарах, сделайте запрос метода /v1/report/info с report_type="SELLER_PRODUCT_DISCOUNTED".
/v1/report/products/movement/create Метод устарел, удалили его из документации.

17 октября 2023

Метод Что изменилось
В раздел Порядок работы с методами добавили подраздел Схема rFBS Express с доставкой в пункт выдачи.

10 октября 2023

Метод Что изменилось
Дополнили таблицу Частые ошибки. Добавили описания ошибок в методах:
/v2/products/stocks
/v3/posting/fbs/ship
/v4/posting/fbs/ship
/v2/posting/fbs/package-label
/v2/posting/fbs/act/create
/v2/posting/fbs/cancel
• /v2/product/import
/v1/posting/carriage-available/list
/v2/posting/fbs/act/create
/v2/posting/fbs/act/check-status
/v2/posting/fbs/act/get-pdf
Для продавцов из СНГ остаются бумажные акты приёма-передачи при работе по схеме FBS. Дополнили описания методов — указали, какие документы можно получить продавцам из России и СНГ.

9 октября 2023

Метод Что изменилось
/v1/posting/carriage-available/list
/v2/posting/fbs/act/create
/v2/posting/fbs/act/check-status
/v2/posting/fbs/act/get-pdf
/v2/posting/fbs/digital/act/check-status
/v2/posting/fbs/digital/act/get-pdf
Отказались от актов приёма-передачи при работе по схеме FBS — теперь вместо них можно получить лист отгрузки. Обновили описания методов, в которых затрагивались акты, и порядок работы с ними:
Схема FBS Стандарт: изменили пункты 6–11.
Схема FBS PickUp с доверительной приёмкой: изменили пункты 6–8.

Подробнее об изменениях на dev.ozon.ru

6 октября 2023

Метод Что изменилось
/v1/description-category/tree Добавили новую версию метода для получения дерева категорий и типов товаров.
/v1/description-category/attribute Добавили новую версию метода для получения характеристик категории и типа товара.
/v1/description-category/attribute/values Добавили новую версию метода для получения значений характеристики.
/v2/category/tree
/v3/category/attribute
/v2/category/attribute/values
Методы устаревают и будут отключены в будущем. Переключитесь на новые версии — указали их в описании методов.
/v3/products/info/attributes
/v2/product/info
/v2/product/info/list
Добавили параметр description_category_id в ответах методов и указали, как его использовать. Пометили параметр category_id в ответах методов как устаревающий и указали, как его использовать.
В разделе Порядок работы с методами → Выгрузите атрибуты и характеристики Ozon обновили версии методов.

4 октября 2023

Метод Что изменилось
/v1/barcode/add Добавили метод для привязки штрихкодов к товарам.
/v1/barcode/generate Добавили метод для создания штрихкодов на товары.

5 сентября 2023

Метод Что изменилось
/v1/polygon/delete Метод устарел, удалили его из документации.

1 сентября 2023

Метод Что изменилось
/v2/products/stocks Добавили описание ошибки MP_DELIVERY_ONLY_3PL_ERROR:
• в описание параметра result.errors в ответе метода,
• в раздел «Частые ошибки».

30 августа 2023

Метод Что изменилось
/v4/product/info/prices Добавили информацию о работе параметров fbo_direct_flow_trans_max_amount и fbo_direct_flow_trans_min_amount в описание метода.
/v2/product/info Добавили информацию о работе параметра min_price в описание метода.

25 августа 2023

Метод Что изменилось
/v1/analytics/data Добавили ограничения для продавцов без Premium-подписки:
• в описание метода,
• в описание параметров date_from, dimension и metrics в запросе метода.

24 августа 2023

Метод Что изменилось
/v1/product/import/prices Обновили описание параметра price в запросе метода. Указали, какой должна быть разница между price и old_price.

22 августа 2023

Метод Что изменилось
/v1/report/transactions/create Метод устарел, удалили его из документации. Используйте /v3/finance/transaction/list.
/v2/product/info/limit

/v3/product/info/limit
Методы устарели, удалили их документации. Используйте /v4/product/info/limit.
/v1/report/products/prices/create Метод устарел, удалили его из документации. Используйте /v4/product/info/price.
/v1/analytics/item_turnover Метод устарел, удалили его из документации. Чтобы получить отчёт по оборачиваемости FBO, запросите его в личном кабинете.
/v1/analytics/stock_on_warehouses Метод устарел, удалили его из документации. Используйте /v2/analytics/stock_on_warehouses.
/v2/returns/company/fbs Метод устарел, удалили его из документации. Используйте /v3/returns/company/fbs.
/v1/report/finance/create Метод устарел, удалили его из документации. Используйте /v1/finance/cash-flow-statement/list.
/v2/returns/company/fbo Метод устарел, удалили его из документации. Используйте /v3/returns/company/fbo.

2 августа 2023

Метод Что изменилось
/v1/analytics/data Удалили метрики из параметра metrics в запросе метода:
adv_view_pdp,
adv_view_search_category,
adv_view_all,
adv_sum_all,
postings,
postings_premium.
/v1/invoice/create-or-update Добавили параметры HS_code, date, number, price и price_currency в запрос метода.

31 июля 2023

Метод Что изменилось
/v1/product/info/stocks-by-warehouse/fbs Добавили параметры sku в запрос метода и result.sku в ответ метода.

Добавили дату отключения параметров fbs_sku в запрос метода и result.fbs_sku в ответ метода.
/v2/product/info Добавили параметр result.sku в ответ метода.

Добавили дату отключения параметров result.fbs_sku и result.fbo_sku в ответ метода.
/v2/product/info/list Добавили параметр result.items.sku в ответ метода.

Добавили дату отключения параметров result.items.fbs_sku и result.items.fbo_sku в ответ метода.

24 июля 2023

Метод Что изменилось
/v4/product/info/prices Добавили в ответ метода параметры:
result.items.acquiring,
result.items.comissions.sales_percent_fbo,
result.items.comissions.sales_percent_fbs.

Дополнили в ответе методов описания параметров:
result.items.comissions.fbs_first_mile_min_amount,
result.items.comissions.fbs_first_mile_max_amount,
result.items.comissions.sales_percent.

19 июля 2023

Метод Что изменилось
/v1/product/import/prices Добавили параметр prices.price_strategy_enabled в запрос метода.

14 июля 2023

Метод Что изменилось
/v2/posting/fbs/act/get-barcode

/v2/posting/fbs/act/get-pdf

/v2/posting/fbs/digital/act/get-pdf

/v2/posting/fbs/package-label

/v2/posting/fbs/act/get-container-labels
Обновили схемы и примеры для ответов методов: методы возвращают результат в бинарном виде.
/v1/posting/fbs/package-label/create Обновили пример ответа.
/v1/posting/fbs/package-label/get Добавили пример ответа.

12 июля 2023

Метод Что изменилось
/v2/posting/fbs/act/get-barcode Удалили параметр doc_type из запроса метода.
/v2/posting/fbs/act/get-barcode/text Добавили метод, в котором можно получить значение штрихода из ответа /v2/posting/fbs/act/get-barcode.

6 июля 2023

Метод Что изменилось
/v3/returns/company/fbo Добавили описание параметра filter.status в запросе метода.

Дополнили описание параметра returns.status_name в ответе метода.

4 июля 2023

Метод Что изменилось
/v3/returns/company/fbs Добавили параметры returns.exemplar_id и returns.return_barcode в ответ метода.

Изменили описания параметров returns.id, returns.return_clearing_id и clearing_id в ответе метода.

27 июня 2023

Метод Что изменилось
Дополнили описание для всех схем FBS и rFBS в разделе Порядок работы с методами → Управляйте заказами FBO, FBS и rFBS. Добавили изначальные статусы отправлений, а также ограничение для сборки заказа.

21 июня 2023

Метод Что изменилось
Добавили описание уведомления TYPE_CREATE_OR_UPDATE_ITEM в раздел Пуш-уведомления → Уведомления, которые отправляет Ozon.
15 июля 2023 года пуш-уведомления TYPE_CREATE_ITEM и TYPE_UPDATE_ITEM будут отключены. Добавили предупреждение в описания уведомлений.

16 июня 2023

Метод Что изменилось
/v3/posting/fbs/list

/v3/posting/fbs/unfulfilled/list
Добавили параметр result.postings.prr_option в ответы методов.
/v3/posting/fbs/get Добавили параметры result.prr_option.code, result.prr_option.price, result.prr_option.currency_code, result.prr_option.floor в ответ метода.

14 июня 2023

Метод Что изменилось
/v1/posting/fbs/timeslot/set Обновили пример запроса.
/v2/posting/fbo/list Исправили формат даты в примере ответа.
/v2/posting/fbs/cancel

/v2/posting/fbs/product/cancel
Дополнили описания методов.
/v2/posting/fbs/act/list Добавили значение статуса closed в описание параметра filter.status в запросе метода.
/v1/product/unarchive С 14 июня 2023 метод не работает. Добавили предупреждение в описание метода и раздел Отключение методов.

2 июня 2023

Метод Что изменилось
/v3/posting/fbs/get Добавили параметры jw_uin и products_requiring_jw_uin в ответ метода.
/v3/posting/fbs/list

/v3/posting/fbs/unfulfilled/list
Добавили параметр products_requiring_jw_uin в ответы методов.
/v4/fbs/posting/product/exemplar/set Добавили параметр jw_uin в запрос метода.
/v4/fbs/posting/product/exemplar/status Добавили параметры jw_uin, jw_uin_check_status и jw_uin_error_codes в ответ метода.
/v4/fbs/posting/product/exemplar/validate Добавили параметр jw_uin в запрос и ответ метода.
/v1/product/archive
/v1/product/unarchive
Добавили ограничение на количество product_id, которые можно передать в одном запросе.

29 мая 2023

Метод Что изменилось
/v2/posting/fbs/act/get-barcode Добавили метод получения штрихкода для отгрузки товара.

25 мая 2023

Метод Что изменилось
/v2/fbs/posting/tracking-number/set Добавили ограничение на добавление трек-номеров в описание метода.
/v1/supplier/available_warehouses Добавили метод для проверки загруженности складов Ozon.

17 мая 2023

Метод Что изменилось
/v1/product/attributes/update Добавили метод для обновления характеристик товара.

27 апреля 2023

Метод Что изменилось
Обновили инструкцию Как получить API-ключ.

20 апреля 2023

Метод Что изменилось
/v1/finance/cash-flow-statement/list Добавили необязательный параметр with_details в запрос метода и параметр details в ответ метода.
/v1/pricing-strategy/competitors/list Добавили метод для получения списка конкурентов.
/v1/pricing-strategy/list Добавили метод для получения списка стратегий ценообразования.
/v1/pricing-strategy/create Добавили метод для создания стратегии ценообразования.
/v1/pricing-strategy/info Добавили метод для получения информации о стратегии ценообразования.
/v1/pricing-strategy/update Добавили метод для изменения списка выбранных конкурентов и названия стратегии ценообразования.
/v1/pricing-strategy/products/add Добавили метод для добавления товаров в стратегию ценообразования.
/v1/pricing-strategy/strategy-ids-by-product-ids Добавили метод для проверки привязки товара к стратегии ценообразования.
/v1/pricing-strategy/products/list Добавили метод для получения списка товаров, которые привязаны к стратегии ценообразования.
/v1/pricing-strategy/products/delete Добавили метод для удаления товаров из стратегии ценообразования.
/v1/pricing-strategy/product/info Добавили метод для получения цены товара у конкурента.
/v1/pricing-strategy/status Добавили метод для включения и отключения стратегии ценообразования.
/v1/pricing-strategy/delete Добавили метод для удаления стратегии ценообразования.
В разделе Порядок работы с методами добавили подраздел Настройте стратегии ценообразования.

11 апреля 2023

Метод Что изменилось
/v1/product/info/subscription Добавили метод для получения количества пользователей, подписанных на товары.
/v2/product/info Добавили параметр result.price_indexes в ответ метода.

Пометили параметр result.price_index в ответе как неактуальный.
/v2/product/info/list

/v4/product/info/prices
Добавили параметр result.items.price_indexes в ответ метода.

Пометили параметр result.items.price_index в ответе как неактуальный.
/v3/posting/fbs/get Добавили параметр result.substatus в ответ метода.
/v3/posting/fbs/list Добавили параметр result.postings.substatus в ответ метода.

Дополнили описание параметра result.postings.status в ответе метода.

10 апреля 2023

Метод Что изменилось
/v1/supply-order/list Добавили метод для получения списка заявок на поставку на склад Ozon.
/v1/supply-order/get Добавили метод для получения информации о заявке на поставку.
/v1/supply-order/items Добавили метод для получения списка товаров в заявке на поставку.
Добавили подраздел Схема FBO → Получите информацию о заявках на поставку в раздел Порядок работы с методами.

22 марта 2023

Метод Что изменилось
/v3/returns/company/fbs Добавили новую версию метода для получения информации о возвратах FBS.

21 марта 2023

Метод Что изменилось
В раздел Пуш-уведомления → Как подключить добавили IP-адреса, с которых отправляются уведомления.
/v2/returns/company/fbs Добавили описание статусов moving, disposed и disposing для параметра filter.status в запросе метода.
/v3/finance/transaction/list Дополнили описание параметра filter.operation_type в запросе метода.

14 марта 2023

Метод Что изменилось
/v3/finance/transaction/list Обновили описание метода: теперь максимальный период, за который можно получить информацию в одном запросе — 1 месяц.

3 марта 2023

Метод Что изменилось
/v1/posting/fbs/timeslot/set Добавили метод для переноса даты доставки отправления.
/v1/posting/fbs/timeslot/change-restrictions Добавили метод для получения доступных дат для переноса доставки и количества доступных переносов.

22 февраля 2023

Метод Что изменилось
/v2/analytics/stock_on_warehouses Добавили новую версию метода для получения отчёта по товарам и остаткам.

17 февраля 2023

Метод Что изменилось
/v1/posting/global/etgb Добавили метод для получения таможенных деклараций ETGB.

16 февраля 2023

Метод Что изменилось
В разделе Пуш-уведомления → Как подключить обновили инструкцию: теперь подключать пуш-уведомления нужно в личном кабинете.

В раздел Уведомления, которые отправляет Ozon добавили описания новых типов уведомлений:
TYPE_NEW_MESSAGE
TYPE_UPDATE_MESSAGE
TYPE_MESSAGE_READ
TYPE_CHAT_CLOSED
/v1/posting/fbs/package-label/create

/v1/posting/fbs/package-label/get
Добавили методы для асинхронного формирования этикеток.

14 февраля 2023

Метод Что изменилось
/v2/returns/company/fbo
/v3/product/info/limit
/v1/analytics/stock_on_warehouses
/v1/analytics/item_turnover
1 апреля 2023 отключим эти методы. Добавили предупреждение в описание методов и в раздел Отключение методов.
/v1/auto/bookings/get
/v1/auto/bookings/list
/v1/auto/cbos/list
/v1/auto/modifications/list
/v1/auto/offers/create
/v1/auto/offers/list
/v1/auto/offers/update
Удалили раздел Автомобили из документации.

13 февраля 2023

Метод Что изменилось
/v4/product/info/limit Добавили метод для получения лимитов на ассортимент, создание и обновление товаров.

10 февраля 2023

Метод Что изменилось
/v1/product/update/discount Добавили метод для установки скидки на уценённые товары, продающиеся по схеме FBS.
/v2/posting/fbs/act/list Обновили описание параметра filter.status в запросе.
/v3/category/attribute Добавили поле result.attributes.category_dependent в ответ метода.

9 февраля 2023

Метод Что изменилось
Дополнили таблицу «Частые ошибки». Добавили описания ошибок для метода /v2/posting/fbs/act/create.
/v2/product/info
/v1/product/info/list
В ответы методов добавили поле updated_at: дата последнего обновления товара.

2 февраля 2023

Метод Что изменилось
/v2/product/import
/v1/product/import-by-sku
В запросах методов обновили описание параметра offer_id: максимальная длина передаваемого значения — 50 символов.
/v1/product/update/offer-id В запросе метода обновили описание параметра new_offer_id: максимальная длина передаваемого значения — 50 символов.

20 января 2023

Метод Что изменилось
/v2/category/tree В запросе метода обновили значение параметра language для китайского языка.

19 января 2023

Метод Что изменилось
/v3/posting/multiboxqty/set Добавили метод для передачи количества коробок в многокоробочных отправлениях.
/v3/posting/fbs/get В ответ метода добавили поля для получения информации о многокоробочных отправлениях: result.is_multibox и result.multi_box_qty.
/v3/posting/fbs/list
/v3/posting/fbs/unfulfilled/list
В ответы методов добавили поля для получения информации о многокоробочных отправлениях: result.postings.is_multibox и result.postings.multi_box_qty.
/v2/posting/fbs/act/get-postings В ответ метода добавили поле result.multi_box_qty для получения количества коробок в многокоробочных отправлениях.

10 января 2023

Метод Что изменилось
Обновили срок подключения пуш-уведомлений.
/v1/supplier/orders/{orderId}/waybill_acceptance_results

/v1/supplier/waybill_acceptance_results/{waybillId}
Убрали методы из документации.
/v3/category/attribute В ответ метода добавили поле result.attributes.is_aspect.
/v2/product/info
/v2/product/info/list
В ответы методов добавили поле barcodes для получения всех штрихкодов товара.

Атрибуты и характеристики Ozon

Дерево категорий и типов товаров

post
/v1/description-category/tree

Возвращает категории и типы для товаров в виде дерева.

Создание товаров доступно только в категориях последнего уровня, сравните именно их с категориями на своей площадке. Категории не создаются по запросу пользователя.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
language
string
Default: "DEFAULT"
Enum: "DEFAULT" "RU" "EN" "TR" "ZH_HANS"

Язык в ответе:

  • EN — английский,
  • RU — русский,
  • TR — турецкий,
  • ZH_HANS — китайский.

По умолчанию используется русский язык.

Ответы

Response Schema: application/json
Array of objects

Список категорий.

Примеры запроса

Content type
application/json
{
  • "language": "DEFAULT"
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "children": [
        • {
          • "children": [
            • {
              }
            ]
          }
        ]
      }
    ]
}

Список характеристик категории

post
/v1/description-category/attribute

Получение характеристик для указанных категории и типа товара.

Если у dictionary_id значение 0, у атрибута нет вложенных справочников. Если значение другое, то справочники есть. Запросите их методом /v1/description-category/attribute/values.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
description_category_id
required
integer <int64>

Идентификатор категории. Можно получить с помощью метода /v1/description-category/tree.

language
string
Default: "DEFAULT"
Enum: "DEFAULT" "RU" "EN" "TR" "ZH_HANS"

Язык в ответе:

  • EN — английский,
  • RU — русский,
  • TR — турецкий,
  • ZH_HANS — китайский.

По умолчанию используется русский язык.

type_id
required
integer <int64>

Идентификатор типа товара. Можно получить с помощью метода /v1/description-category/tree.

Ответы

Response Schema: application/json
Array of objects

Результат запроса.

Array ()
category_dependent
boolean

Признак, что значения словарного атрибута зависят от категории:

  • true — у атрибута разные значения для каждой категории.
  • false — у атрибута одинаковые значения для всех категорий.
description
string

Описание характеристики.

dictionary_id
integer <int64>

Идентификатор справочника.

group_id
integer <int64>

Идентификатор группы характеристик.

group_name
string

Название группы характеристик.

id
integer <int64>

Номер задания на формирование документов.

is_aspect
boolean

Признак аспектного атрибута. Аспектный атрибут — характеристика, по которой отличаются товары одной модели.

Например, у одежды и обуви одной модели могут быть разные расцветки и размеры. То есть цвет и размер — это аспектные атрибуты.

Значения поля:

  • true — атрибут аспектный и его нельзя изменить после поставки товара на склад или продажи со своего склада.
  • false — атрибут не аспектный, можно изменить в любое время.
is_collection
boolean
  • true, если характеристика — набор значений.
  • false, если характеристика — одно значение.
is_required
boolean

Признак обязательной характеристики:

  • true — обязательная характеристика,
  • false — характеристику можно не указывать.
name
string

Название.

type
string

Тип характеристики.

attribute_complex_id
integer <int64>

Идентификатор комплексного атрибута.

max_value_count
integer <int64>

Максимальное количество значений для атрибута.

complex_is_collection
boolean

Признак, что комплексная характеристика — набор значений:

  • true, если комплексная характеристика — набор значений,
  • false, если комплексная характеристика — одно значение.

Примеры запроса

Content type
application/json
{
  • "description_category_id": 200000933,
  • "language": "DEFAULT",
  • "type_id": 93080
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Справочник значений характеристики

post
/v1/description-category/attribute/values

Возвращает справочник значений характеристики.

Узнать, есть ли вложенный справочник, можно через метод /v1/description-category/attribute.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
attribute_id
required
integer <int64>

Идентификатор характеристики. Можно получить с помощью метода /v1/description-category/attribute.

description_category_id
required
integer <int64>

Идентификатор категории. Можно получить с помощью метода /v1/description-category/tree.

language
string
Default: "DEFAULT"
Enum: "DEFAULT" "RU" "EN" "TR" "ZH_HANS"

Язык в ответе:

  • EN — английский,
  • RU — русский,
  • TR — турецкий,
  • ZH_HANS — китайский.

По умолчанию используется русский язык.

last_value_id
integer <int64>

Идентификатор справочника, с которого нужно начать ответ. Если last_value_id — 10, то в ответе будут справочники, начиная с одиннадцатого.

limit
required
integer <int64>

Количество значений в ответе:

  • максимум — 2000,
  • минимум — 1.
type_id
required
integer <int64>

Идентификатор типа товара. Можно получить с помощью метода /v1/description-category/tree.

Ответы

Response Schema: application/json
has_next
boolean

Признак, что в ответе вернулась только часть значений характеристики:

  • true — сделайте повторный запрос с новым параметром last_value_id для получения остальных значений;
  • false — ответ содержит все значения характеристики.
Array of objects

Значения характеристики.

Array ()
id
integer <int64>

Идентификатор значения характеристики.

info
string

Дополнительное описание.

picture
string

Ссылка на изображение.

value
string

Значение характеристики товара.

Примеры запроса

Content type
application/json
{
  • "attribute_id": 85,
  • "description_category_id": 17054869,
  • "language": "DEFAULT",
  • "last_value_id": 0,
  • "limit": 100,
  • "type_id": 97311
}

Примеры ответа

Content type
application/json
{}

Поиск по справочным значениям характеристики

post
/v1/description-category/attribute/values/search

Возвращает справочные значения характеристики по заданному значению value в запросе.

Узнать, есть ли вложенный справочник, можно через метод /v1/description-category/attribute.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
attribute_id
required
integer <int64>

Идентификатор характеристики. Можно получить с помощью метода /v1/description-category/attribute.

description_category_id
required
integer <int64>

Идентификатор категории. Можно получить с помощью метода /v1/description-category/tree.

limit
required
integer <int64>

Количество значений в ответе:

  • максимум — 100,
  • минимум — 1.
type_id
required
integer <int64>

Идентификатор типа товара. Можно получить с помощью метода /v1/description-category/tree.

value
required
string

Значение, по которому система будет искать справочные значения. Минимум — 2 символа.

Ответы

Response Schema: application/json
Array of objects

Значения характеристики.

Array ()
id
integer <int64>

Идентификатор значения характеристики.

info
string

Дополнительная информация.

picture
string

Ссылка на изображение.

value
string

Значение характеристики товара.

Примеры запроса

Content type
application/json
{
  • "attribute_id": 0,
  • "description_category_id": 0,
  • "limit": 0,
  • "type_id": 0,
  • "value": "string"
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Загрузка и обновление товаров

Создать или обновить товар

post
/v3/product/import

Метод для создания товаров и обновления информации о них.

В сутки можно создать или обновить определённое количество товаров. Чтобы узнать лимит, используйте /v4/product/info/limit. Если количество загрузок и обновлений товаров превысит лимит, появится ошибка item_limit_exceeded.

В одном запросе можно передать до 100 товаров. Каждый товар — это отдельный элемент в массиве items. Укажите всю информацию о товаре: его характеристики, штрихкод, изображения, габариты, цену и валюту цены.

При обновлении товара передайте в запросе всю информацию о нём.

Указанная валюта должна совпадать с той, которая установлена в настройках личного кабинета. По умолчанию передаётся RUB — российский рубль. Например, если у вас установлена валюта юань, передавайте значение CNY, иначе вернётся ошибка.

Товар не будет создан или обновлён, если вы заполните неправильно или не укажете:

  • Обязательные характеристики: характеристики отличаются для разных категорий — их можно посмотреть в Базе знаний продавца или получить методом /v1/description-category/attribute.
  • Реальные объёмно-весовые характеристики: depth, width, height, dimension_unit, weight, weight_unit. Не пропускайте эти параметры в запросе и не указывайте 0.

Для некоторых характеристик можно использовать HTML-теги.

После модерации товар появится в вашем личном кабинете, но не будет виден пользователям, пока вы не выставите его на продажу.

Каждый товар в запросе — отдельный элемент массива items.

Чтобы объединить две карточки, для каждой передайте 9048 в массиве attributes. Все атрибуты в этих карточках, кроме размера или цвета, должны совпадать.

Загрузка изображений

Для загрузки передайте в запросе ссылки на изображения в общедоступном облачном хранилище. Формат изображения по ссылке — JPG или PNG.

Изображения в массиве images располагайте в соответствии с желаемым порядком на сайте. Для загрузки главного изображения товара используйте параметр primary_image. Если не передать значение primary_image, главным будет первое изображение в массиве images.

Для каждого товара вы можете загрузить до 15 изображений, включая главное. Если передать значение primary_image, максимальное количество изображений в images — 14. Если параметр primary_image пустой, то в images можно передать до 15 изображений.

Для загрузки изображений 360 используйте поле images360, для загрузки маркетингового цвета — color_image.

Если вы хотите изменить состав или порядок изображений, получите информацию с помощью метода /v3/product/info/list — в нём отображается текущий порядок и состав изображений. Скопируйте данные полей images, images360, color_image, измените и дополните состав или порядок в соответствии с необходимостью.

Загрузка видео

Для загрузки передайте в запросе ссылки на видео.

Для этого в параметре complex_attributes передайте объект. В нём в массиве attributes передайте 2 объекта с complex_id = 100001:

  • В первом передайте укажите id = 21841 и в массиве values передайте объект с ссылкой на видео.

    Пример:

    {
      "complex_id": 100001,
      "id": 21841,
      "values": [
        {
          "value": "https://www.youtube.com/watch?v=ZwM0iBn03dY"
        }
      ]
    }
  • Во втором укажите значение id = 21837 и в массиве values передайте объект с названием видео.

    Пример:

    {
      "complex_id": 100001,
      "id": 21837,
      "values": [
        {
          "value": "videoName_1"
        }
      ]
    }

Если вы хотите загрузить несколько видео, передавайте значения для каждого видео в разных объектах массива values.

Пример:

  {
    "complex_id": 100001,
    "id": 21837,
    "values": [
      {
        "value": "videoName_1"
      },
      {
        "value": "videoName_2"
      }
    ]
  },
  {
    "complex_id": 100001,
    "id": 21841,
    "values": [
      {
        "value": "https://www.youtube.com/watch?v=ZwM0iBn03dY"
      },
      {
        "value": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
      }
    ]
  }

Загрузка таблицы размеров

Вы можете добавить в карточку товара таблицу размеров, созданную с помощью конструктора. Передайте её в массиве attributes в формате JSON как Rich-контент id = 13164.

Конструктор в формате JSON
Подробнее о конструкторе в Базе знаний продавца

Загрузка видеообложки

Вы можете загрузить видеообложку через complex_attributes.

Пример:

"complex_attributes": [
  {
    "attributes": [
      {
        "id": 21845,
        "complex_id": 100002,
        "values": [
          {
          "dictionary_value_id": 0,
          "value": "https://v.ozone.ru/vod/video-10/01GFATWQVCDE7G5B721421P1231Q7/asset_1.mp4"
          }
        ]
      }
    ]
  }
]
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
Array of objects

Массив данных.

Ответы

Response Schema: application/json
object

Результаты запроса.

task_id
integer <int64>

Номер задания на загрузку товаров.

Примеры запроса

Content type
application/json
Example
{
  • "items": [
    • {
      • "attributes": [
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          }
        ],
      • "promotions": [
        • {
          }
        ],
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Узнать статус добавления или обновления товара

post
/v1/product/import/info

Позволяет получить статус создания или обновления карточки товара.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
task_id
required
integer <int64>

Код задачи на импорт товаров. Можно получить с помощью метода /v3/product/import.

Ответы

Response Schema: application/json
object
Array of objects

Информация о товарах.

total
integer <int32>

Идентификатор товара в системе продавца — артикул.

Примеры запроса

Content type
application/json
{
  • "task_id": "172549793"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "items": [
      • {
        }
      ],
    }
}

Создать товар по SKU

post
/v1/product/import-by-sku

Метод создаёт копию карточки товара с указанным SKU.

Создать копию не получится, если продавец запретил копирование своих карточек.

Обновить товар по SKU нельзя.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
Array of objects <= 1000 items

Информация о товарах.

Ответы

Response Schema: application/json
object
task_id
integer <int64>

Код задачи на импорт товаров.

unmatched_sku_list
Array of integers <int64>

Список идентификаторов товаров в системе продавца — product_id.

Примеры запроса

Content type
application/json
{
  • "items": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Обновить характеристики товара

post
/v1/product/attributes/update
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
Array of objects

Товары и характеристики, которые нужно обновить.

Ответы

Response Schema: application/json
task_id
integer <int64>

Номер задания на обновление товаров.

Чтобы проверить статус обновления, передайте полученное значение в метод /v1/product/import/info.

Примеры запроса

Content type
application/json
{
  • "items": [
    • {
      • "attributes": [
        • {
          • "values": [
            • {
              }
            ]
          }
        ],
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "task_id": 0
}

Загрузить или обновить изображения товара

post
/v1/product/pictures/import

Метод для загрузки или обновления изображений товара.

При каждом вызове метода передавайте все изображения, которые должны быть на карточке товара. Например, если вы вызвали метод и загрузили 10 изображений, а затем вызвали метод второй раз и загрузили ещё одно, то все 10 предыдущих сотрутся.

Для загрузки передайте адрес ссылки на изображение в общедоступном облачном хранилище. Формат изображения по ссылке — JPG или PNG.

Изображения в массиве images располагайте в соответствии с желаемым порядком на сайте. Главным будет первое изображение в массиве.

Для каждого товара вы можете загрузить до 15 изображений.

Для загрузки изображений 360 используйте поле images360, для загрузки маркетингового цвета — color_image.

Если вы хотите изменить состав или порядок изображений, получите информацию с помощью метода /v3/product/info/list — в нём отображается текущий порядок и состав изображений. Скопируйте данные полей images, images360, color_image, измените и дополните состав или порядок в соответствии с необходимостью.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
color_image
string

Маркетинговый цвет.

images
Array of strings

Массив ссылок на изображения. Изображения в массиве расположены в порядке их расположения на сайте. Первое изображение в массиве будет главным.

images360
Array of strings

Массив изображений 360. До 70 штук.

Формат: адрес ссылки на изображение в общедоступном облачном хранилище. Формат изображения по ссылке — JPG.

product_id
required
integer <int64>

Идентификатор товара в системе продавца — product_id.

Ответы

Response Schema: application/json
object

Результат работы метода.

Array of objects

Примеры запроса

Content type
application/json
{
  • "color_image": "string",
  • "images": [
    ],
  • "images360": [
    ],
  • "product_id": 0
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "pictures": [
      • {
        }
      ]
    }
}

Список товаров

post
/v3/product/list

Метод для получения списка всех товаров.

Если вы используете фильтр по идентификатору offer_id или product_id, остальные параметры заполнять не обязательно. За один раз вы можете использовать только одну группу идентификаторов, не больше 1000 товаров.

Если вы не используете для отображения идентификаторы, укажите limit и last_id в следующих запросах.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Фильтр по товарам.

last_id
string

Идентификатор последнего значения на странице. При первом запросе оставьте это поле пустым.

Чтобы получить следующие значения, укажите last_id из ответа предыдущего запроса.

limit
integer <int64>

Количество значений на странице. Минимум — 1, максимум — 1000.

Ответы

Response Schema: application/json
object

Результат.

Array of objects

Список товаров.

last_id
string

Идентификатор последнего значения на странице.

Чтобы получить следующие значения, передайте полученное значение в следующем запросе в параметре last_id.

total
integer <int32>

Всего товаров.

Примеры запроса

Content type
application/json
{
  • "filter": {
    • "offer_id": [
      ],
    • "product_id": [
      ],
    },
  • "last_id": "",
  • "limit": 100
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "items": [
      • {
        • "quants": [
          • {
            }
          ]
        }
      ],
    }
}

Получить контент-рейтинг товаров по SKU

post
/v1/product/rating-by-sku

Метод для получения контент-рейтинга товаров, а также рекомендаций по его увеличению.

Подробнее о контент-рейтинге

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
skus
required
Array of strings <int64>

Идентификаторы товаров в системе Ozon — SKU, для которых нужно вернуть контент-рейтинг.

Ответы

Response Schema: application/json
Array of objects

Контент-рейтинг товаров.

Array ()
sku
integer <int64>

Идентификатор товара на Ozon.

rating
number <float>

Контент-рейтинг товара: от 0 до 100.

Array of objects

Группы характеристик, из которых складывается контент-рейтинг.

Примеры запроса

Content type
application/json
{
  • "skus": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "products": [
    • {
      • "groups": [
        • {
          • "conditions": [
            • {
              },
            • {
              },
            • {
              },
            • {
              }
            ],
          • "improve_attributes": [
            • {
              },
            • {
              }
            ],
          },
        • {
          • "conditions": [
            • {
              },
            • {
              },
            • {
              }
            ],
          • "improve_attributes": [
            • {
              },
            • {
              },
            • {
              },
            • {
              },
            • {
              },
            • {
              },
            • {
              },
            • {
              },
            • {
              },
            • {
              },
            • {
              }
            ],
          },
        • {
          • "conditions": [
            • {
              },
            • {
              }
            ],
          • "improve_attributes": [
            • {
              }
            ],
          },
        • {
          • "conditions": [
            • {
              },
            • {
              },
            • {
              }
            ],
          • "improve_attributes": [
            • {
              }
            ],
          }
        ]
      }
    ]
}

Получить информацию о товарах по идентификаторам

post
/v3/product/info/list

Метод для получения информации о товарах по их идентификаторам.

В теле запроса должен быть массив однотипных идентификаторов, в ответе будет массив items.

В одном запросе вы можете передать не больше 1000 товаров по параметрам offer_id, product_id и sku в сумме.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
offer_id
Array of strings

Идентификатор товара в системе продавца — артикул.

product_id
Array of strings <int64>

Идентификатор товара в системе продавца — product_id.

sku
Array of strings <int64>

Идентификатор товара в системе Ozon — SKU.

Ответы

Response Schema: application/json
Array of objects

Массив данных.

Array ()
barcodes
Array of strings

Все штрихкоды товара.

color_image
Array of strings

Изображение цвета товара.

Array of objects

Информация о комиссиях.

created_at
string <date-time>

Дата и время создания товара.

currency_code
string

Валюта.

description_category_id
integer <int64>

Идентификатор категории. Используйте его с методами /v1/description-category/attribute и /v1/description-category/attribute/values.

discounted_fbo_stocks
integer <int32>

Остатки уценённого товара на складе Ozon.

Array of objects

Информация об ошибках при создании или валидации товара.

has_discounted_fbo_item
boolean

Признак, что у товара есть уценённые аналоги на складе Ozon.

id
integer <int64>

Идентификатор товара в системе продавца — product_id.

images
Array of strings

Массив ссылок на изображения. Изображения в массиве расположены в порядке их расположения на сайте. Если параметр primary_image не указан, первое изображение в массиве главное для товара.

images360
Array of strings

Массив изображений 360.

is_archived
boolean

true, если товар архивирован вручную.

is_autoarchived
boolean

true, если товар архивирован автоматически.

is_discounted
boolean

Признак, является ли товар уценённым:

  • Если товар создавался продавцом как уценённый — true.
  • Если товар не уценённый или был уценён Ozon — false.
is_kgt
boolean

Признак крупногабаритного товара.

is_prepayment_allowed
boolean

true, если возможна предоплата.

is_super
marketing_price
string

Цена на товар с учётом всех акций, которая будет указана на витрине Ozon, без учёта скидки по Ozon Карте.

min_price
string

Минимальная цена товара после применения акций.

object

Информация о модели товара.

name
string

Название.

offer_id
string

Идентификатор товара в системе продавца — артикул.

old_price
string

Цена до учёта скидок. На карточке товара отображается зачёркнутой.

price
string

Цена товара с учётом скидок — это значение показывается на карточке товара.

object

Ценовые индексы товара.

primary_image
Array of strings

Главное изображение товара.

Array of objects

Информация об источниках создания товара.

object

Информация о статусах товара.

object

Информация об остатках товара.

type_id
integer <int64>

Идентификатор типа товара.

updated_at
string <date-time>

Дата последнего обновления товара.

vat
string

Ставка НДС для товара.

object

Настройки видимости товара.

volume_weight
number <double>

Объёмный вес товара.

Примеры запроса

Content type
application/json
{
  • "offer_id": [
    ],
  • "product_id": [
    ],
  • "sku": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "items": [
    • {
      • "barcodes": [
        ],
      • "color_image": [
        ],
      • "commissions": [
        • {
          }
        ],
      • "errors": [
        • {
          • "texts": {
            • "params": [
              • {
                }
              ],
            }
          }
        ],
      • "images": [
        ],
      • "images360": [
        ],
      • "model_info": {
        },
      • "price_indexes": {
        • "external_index_data": {
          },
        • "ozon_index_data": {
          },
        • "self_marketplaces_index_data": {
          }
        },
      • "primary_image": [
        ],
      • "sources": [
        • {
          }
        ],
      • "statuses": {
        },
      • "stocks": {
        • "stocks": [
          • {
            }
          ]
        },
      • "visibility_details": {
        },
      }
    ]
}

Получить описание характеристик товара

post
/v4/product/info/attributes

Возвращает описание характеристик товаров по идентификатору и видимости. Товар можно искать по offer_id, product_id или sku.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Фильтр по товарам.

last_id
string

Идентификатор последнего значения на странице. Оставьте это поле пустым при выполнении первого запроса.

Чтобы получить следующие значения, укажите last_id из ответа предыдущего запроса.

limit
integer <int32> [ 1 .. 1000 ]

Количество значений на странице.

sort_by
string

Параметр, по которому товары будут отсортированы:

  • sku — сортировка по идентификатору товара в системе Ozon;
  • offer_id — сортировка по артикулу товара;
  • id — сортировка по идентификатору товара;
  • title — сортировка по названию товара.
sort_dir
string

Направление сортировки:

  • asc — по возрастанию,
  • desc — по убыванию.

Ответы

Response Schema: application/json
Array of objects

Результаты запроса.

Array ()
Array of objects

Массив характеристик товара.

barcode
string

Штрихкод.

barcodes
array of strings

Все штрихкоды товара.

description_category_id
integer <int64>

Идентификатор категории. Используйте его с методами /v1/description-category/attribute и /v1/description-category/attribute/values.

color_image
string

Маркетинговый цвет.

Array of objects

Массив вложенных характеристик.

depth
integer <int64>

Глубина.

dimension_unit
string

Единица измерения габаритов:

  • mm — миллиметры,
  • cm — сантиметры,
  • in — дюймы.
height
integer <int64>

Высота упаковки.

id
integer <int64>

Идентификатор товара в системе продавца — product_id.

images
array of strings

Массив ссылок на изображения товара. Порядок изображений аналогичен порядку в карточке товаров.

object

Информация о модели.

name
string <= 500 characters

Название товара.

offer_id
string

Идентификатор товара в системе продавца — артикул.

Array of objects

Массив PDF-файлов.

primary_image
string

Ссылка на главное изображение товара.

sku
string

Идентификатор товара в системе Ozon — SKU.

type_id
integer <int64>

Идентификатор типа товара.

weight
integer <int64>

Вес товара в упаковке.

weight_unit
string

Единица измерения веса.

width
integer <int64>

Ширина упаковки.

last_id
string

Идентификатор последнего значения на странице.

Чтобы получить следующие значения, укажите полученное значение в следующем запросе в параметре last_id.

total
string <int64>

Количество товаров в списке.

Примеры запроса

Content type
application/json
{
  • "filter": {
    • "product_id": [
      ],
    • "offer_id": [
      ],
    • "sku": [
      ],
    },
  • "limit": 100,
  • "sort_dir": "ASC"
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "barcodes": [
        ],
      • "model_info": {
        },
      • "attributes": [
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          },
        • {
          • "values": [
            • {
              }
            ]
          }
        ],
      }
    ],
  • "total": 1,
  • "last_id": "onVsfA=="
}

Получить описание товара

post
/v1/product/info/description
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
One of
offer_id
required
string

Идентификатор товара в системе продавца — артикул.

product_id
integer <int64>

Идентификатор товара в системе продавца — product_id.

Ответы

Response Schema: application/json
object
description
string

Описание.

id
integer <int64>

Идентификатор.

name
string

Название.

offer_id
string

Идентификатор товара в системе продавца — артикул.

Примеры запроса

Content type
application/json
{
  • "offer_id": "5",
  • "product_id": 73453843
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Лимиты на ассортимент, создание и обновление товаров

post
/v4/product/info/limit

Метод для получения информации о лимитах:

  • На ассортимент — сколько всего товаров можно создать в вашем личном кабинете.
  • На создание товаров — сколько товаров можно создать в сутки.
  • На обновление товаров — сколько товаров можно отредактировать в сутки.

Если у вас есть лимит на ассортимент и вы израсходуете его, вы не сможете создавать новые товары.

Подробнее о лимитах в Базе знаний продавца

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Ответы

Response Schema: application/json
object

Суточный лимит на создание товаров.

object

Суточный лимит на обновление товаров.

object

Лимит на ассортимент.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
application/json
{
  • "daily_create": {
    },
  • "daily_update": {
    },
  • "total": {
    }
}

Изменить артикулы товаров из системы продавца

post
/v1/product/update/offer-id

Метод для изменения offer_id, привязанных к товарам. Вы можете изменить несколько offer_id.

Рекомендуем передавать до 250 значений в массиве.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
required
Array of objects

Список пар с новыми и старыми значениями артикулов.

Ответы

Response Schema: application/json
Array of objects

Список ошибок.

Array ()
message
string

Сообщение об ошибке.

offer_id
string

Артикул товара, который не получилось изменить.

Примеры запроса

Content type
application/json
{
  • "update_offer_id": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Перенести товар в архив

post
/v1/product/archive
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
product_id
required
Array of integers <int64>

Список идентификаторов товаров в системе продавца — product_id. Вы можете передать до 100 идентификаторов за раз.

Ответы

Response Schema: application/json
result
boolean

Результат обработки запроса. true, если запрос выполнен без ошибок.

Примеры запроса

Content type
application/json
{
  • "product_id": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Вернуть товар из архива

post
/v1/product/unarchive
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
product_id
required
Array of integers <int64>

Список идентификаторов товаров в системе продавца — product_id. Вы можете передать до 100 идентификаторов за раз.

В сутки можно восстановить из архива не больше 10 товаров, которые были архивированы автоматически. Если указать больше в одном запросе, вернётся ошибка restore quota is exceeded. Лимит обновляется в 03:00 по московскому времени. На разархивацию товаров, перенесённых в архив вручную, ограничений нет.

Ответы

Response Schema: application/json
result
boolean

Результат обработки запроса. true, если запрос выполнен без ошибок.

Примеры запроса

Content type
application/json
{
  • "product_id": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Удалить товар без SKU из архива

post
/v2/products/delete

В одном запросе можно передать до 500 идентификаторов.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
required
Array of objects

Идентификатор товара в системе продавца — product_id.

Ответы

Response Schema: application/json
Array of objects

Статус обработки запроса.

Array ()
error
string

Причина ошибки, которая возникла при обработке запроса.

is_deleted
boolean

Если запрос выполнен без ошибок и товары удалены — true.

offer_id
string

Идентификатор товара в системе продавца — артикул.

Примеры запроса

Content type
application/json
{
  • "products": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "status": [
    • {
      }
    ]
}

Загрузить коды активации для услуг и цифровых товаров

post
/v1/product/upload_digital_codes

Загрузите коды активации, если вы загружаете цифровые товары или услуги. Код активации привязывается к карточке цифрового товара.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
digital_codes
required
Array of strings

Цифровые коды активации.

product_id
required
integer <int64>

Идентификатор товара в системе продавца — product_id.

Ответы

Response Schema: application/json
object
task_id
integer <int64>

Код задачи на загрузку кодов.

Примеры запроса

Content type
application/json
{
  • "digital_codes": [
    ],
  • "product_id": 73160317
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Статус загрузки кодов активации

post
/v1/product/upload_digital_codes/info

Метод для получения статуса загрузки кодов активации для услуг и цифровых товаров.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
task_id
required
integer <int64>

Идентификатор задачи на загрузку кодов активации, полученный в ответе метода /v1/product/upload_digital_codes.

Ответы

Response Schema: application/json
object
status
string

Статус загрузки:

  • pending — товар в очереди на обработку.
  • imported — товар успешно загружен.
  • failed — товар загружен с ошибками.

Примеры запроса

Content type
application/json
{
  • "task_id": 178574231
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Количество подписавшихся на товар пользователей

post
/v1/product/info/subscription

Метод для получения количества пользователей, которые нажали Узнать о поступлении на странице товара.

Вы можете передать несколько товаров в запросе.

Request Body schema: application/json
skus
required
Array of strings <int64>

Список SKU, идентификаторов товара в системе Ozon.

Ответы

Response Schema: application/json
Array of objects

Результат работы метода.

Array ()
count
integer <int64>

Количество подписавшихся пользователей.

sku
integer <int64>

Идентификатор товара в системе Ozon, SKU.

Примеры запроса

Content type
application/json
{
  • "skus": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Получить связанные SKU

post
/v1/product/related-sku/get

Метод для получения единого SKU по старым идентификаторам SKU FBS и SKU FBO. В ответе будут все SKU, связанные с переданными.

Метод может обработать любые SKU, даже скрытые или удалённые.

Передавайте до 200 SKU в одном запросе.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
sku
required
Array of strings <int64>

Список SKU.

Ответы

Response Schema: application/json
Array of objects

Информация о связанных SKU.

Array of objects

Ошибки.

Примеры запроса

Content type
application/json
{
  • "sku": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "items": [
    • {
      }
    ],
  • "errors": [
    • {
      }
    ]
}

Получить изображения товаров

post
/v2/product/pictures/info
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
product_id
required
Array of strings <int64> <= 1000 items

Список идентификаторов товаров в системе продавца — product_id.

Ответы

Response Schema: application/json
Array of objects

Изображения товаров.

Array ()
product_id
integer <int64>

Идентификатор товара в системе продавца — product_id.

primary_photo
Array of strings

Ссылка на главное изображение.

photo
Array of strings

Ссылки на фотографии товара.

color_photo
Array of strings

Ссылки на загруженные образцы цвета.

photo_360
Array of strings

Ссылки на изображения 360.

Примеры запроса

Content type
application/json
{
  • "product_id": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "items": [
    • {
      • "primary_photo": [
        ],
      • "photo": [
        ],
      • "color_photo": [
        ],
      • "photo_360": [
        ]
      }
    ]
}

Штрихкоды товаров

Привязать штрихкод к товару

post
/v1/barcode/add

Если у товара есть штрихкод, который не указан в системе Ozon, привяжите его с помощью этого метода. Если штрихкода нет, вы можете создать его через метод /v1/barcode/generate.

За один запрос вы можете назначить штрихкод не больше чем на 100 товаров. На одном товаре может быть до 100 штрихкодов. С одного аккаунта продавца можно использовать метод не больше 20 раз в минуту.

Request Body schema: application/json
required
Array of objects

Список штрихкодов и товаров.

Ответы

Response Schema: application/json
Array of objects

Список ошибок.

Array ()
code
string

Код ошибки.

error
string

Описание ошибки.

barcode
string

Штрихкод, который не удалось привязать.

sku
integer <int64>

Идентификатор товара, к которому не удалось привязать штрихкод.

Примеры запроса

Content type
application/json
{
  • "barcodes": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Создать штрихкод для товара

post
/v1/barcode/generate

Если у товара нет штрихкода, вы можете создать его с помощью этого метода. Если штрихкод уже есть, но он не указан в системе Ozon, вы можете привязать его через метод /v1/barcode/add.

За один запрос вы можете создать штрихкоды не больше чем для 100 товаров. С одного аккаунта продавца можно использовать метод не больше 20 раз в минуту.

Request Body schema: application/json
product_ids
required
Array of strings <int64>

Идентификаторы товаров, для которых нужно создать штрихкод.

Ответы

Response Schema: application/json
Array of objects

Ошибки при создании штрихкода.

Array ()
code
string

Код ошибки.

error
string

Описание ошибки.

barcode
string

Штрихкод, при создании которого произошла ошибка.

product_id
integer <int64>

Идентификатор товара, для которого не удалось создать штрихкод.

Примеры запроса

Content type
application/json
{
  • "product_ids": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "errors": [
    • {
      }
    ]
}

Цены и остатки товаров

Обновить остатки

post
/v1/product/import/stocks

Позволяет изменить информацию о количестве товара в наличии:

  • когда у вас один склад;
  • когда у вас много складов, но FBS склад, на котором будет обновлён остаток, только один.

За один запрос можно изменить наличие для 100 товаров. С одного аккаунта продавца можно отправить до 80 запросов в минуту.

Вы можете задать наличие товара только после того, как его статус сменится на price_sent.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
Array of objects

Информация о товарах на складах.

Ответы

Response Schema: application/json
Array of objects

Результаты запроса.

Array ()
Array of objects

Массив ошибок, которые возникли при обработке запроса.

offer_id
string

Идентификатор товара в системе продавца — артикул.

product_id
integer <int64>

Идентификатор товара в системе продавца — product_id.

updated
boolean

Если информации о товаре успешно обновлена — true.

Примеры запроса

Content type
application/json
{
  • "stocks": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Обновить количество товаров на складах

post
/v2/products/stocks

Позволяет изменить информацию о количестве товара в наличии.

За один запрос можно изменить наличие для 100 товаров. С одного аккаунта продавца можно отправить до 80 запросов в минуту.

Вы можете задать наличие товара только после того, как его статус сменится на price_sent.

Остатки крупногабаритных товаров можно обновлять только на предназначенных для них складах.

Если запрос содержит оба параметра — offer_id и product_id, изменения применятся к товару с offer_id. Для избежания неоднозначности используйте только один из параметров.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
required
Array of objects

Информация о товарах на складах.

Ответы

Response Schema: application/json
Array of objects
Array ()
Array of objects

Массив ошибок, которые возникли при обработке запроса.

offer_id
string

Идентификатор товара в системе продавца — артикул.

product_id
integer <int64>

Идентификатор товара в системе продавца — product_id.

quant_size
integer <int64>

Показывает, количество товара какого типа вы обновляете:

  • 1 — если обновляете остатки обычного товара;
  • размер кванта — если обновляете остатки эконом-товара.
updated
boolean

Если запрос выполнен успешно и остатки обновлены — true.

warehouse_id
integer <int64>

Идентификатор склада.

Примеры запроса

Content type
application/json
{
  • "stocks": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Информация о количестве товаров

post
/v4/product/info/stocks

Возвращает информацию о ĸоличестве товаров по схемам FBS и rFBS:

  • сĸольĸо единиц есть в наличии,
  • сĸольĸо зарезервировано поĸупателями.

Чтобы получить информацию об остатках по схеме FBO, используйте метод v1/analytics/manage/stocks.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
cursor
string

Указатель для выборки следующих данных.

required
object

Фильтр по товарам.

limit
required
integer <int32>

Количество значений на странице. Минимум — 1, максимум — 1000.

Ответы

Response Schema: application/json
cursor
string

Указатель для выборки следующих данных.

Array of objects

Информация о товарах.

total
integer <int32>

Количество уникальных товаров, для которых выводится информация об остатках.

Примеры запроса

Content type
application/json
{
  • "cursor": "string",
  • "filter": {
    • "offer_id": [
      ],
    • "product_id": [
      ],
    • "with_quant": {
      }
    },
  • "limit": 0
}

Примеры ответа

Content type
application/json
{
  • "cursor": "string",
  • "items": [
    • {
      • "stocks": [
        • {
          }
        ]
      }
    ],
  • "total": 0
}

Информация об остатках на складах продавца (FBS и rFBS)

post
/v1/product/info/stocks-by-warehouse/fbs
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
sku
required
Array of strings <int64>

Идентификатор товара в системе Ozon — SKU.

Ответы

Response Schema: application/json
Array of objects

Результат работы метода.

Array ()
sku
integer <int64>

Идентификатор товара в системе Ozon — SKU.

present
integer <int64>

Общее количество товара на складе.

product_id
integer <int64>

Идентификатор товара в системе продавца — артикул.

reserved
integer <int64>

Количество зарезервированных товаров на складе.

warehouse_id
integer <int64>

Идентификатор склада.

warehouse_name
string

Название склада.

Примеры запроса

Content type
application/json
{
  • "sku": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Обновить цену

post
/v1/product/import/prices

Позволяет изменить цену одного или нескольких товаров. Цену каждого товара можно обновлять не больше 10 раз в час. Чтобы сбросить old_price, поставьте 0 у этого параметра.

Если у товара установлена минимальная цена и включено автоприменение в акции, отключите его и обновите минимальную цену, иначе вернётся ошибка action_price_enabled_min_price_missing.

Если запрос содержит оба параметра — offer_id и product_id, изменения применятся к товару с offer_id. Для избежания неоднозначности используйте только один из параметров.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
Array of objects <= 1000 items

Информация о ценах товаров.

Ответы

Response Schema: application/json
Array of objects

Результаты запроса.

Array ()
Array of objects

Массив ошибок, которые возникли при обработке запроса.

offer_id
string

Идентификатор товара в системе продавца — артикул.

product_id
integer <int64>

Идентификатор товара в системе продавца — product_id.

updated
boolean

Если информации о товаре успешно обновлена — true.

Примеры запроса

Content type
application/json
{
  • "prices": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Получить информацию о цене товара

post
/v5/product/info/prices
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
cursor
string

Указатель для выборки следующих данных.

required
object

Фильтр по товарам.

limit
required
integer <int32> [ 1 .. 1000 ]

Количество значений на странице.

Ответы

Response Schema: application/json
cursor
string

Указатель для выборки следующих данных.

Array of objects

Список товаров.

total
integer <int32>

Количество товаров в списке.

Примеры запроса

Content type
application/json
{
  • "cursor": "",
  • "filter": {
    • "offer_id": [
      ],
    • "product_id": [
      ],
    },
  • "limit": 100
}

Примеры ответа

Content type
application/json
{
  • "cursor": "string",
  • "items": [
    • {
      • "commissions": {
        },
      • "marketing_actions": {
        • "actions": [
          • {
            }
          ],
        },
      • "price": {
        },
      • "price_indexes": {
        • "external_index_data": {
          },
        • "ozon_index_data": {
          },
        • "self_marketplaces_index_data": {
          }
        },
      }
    ],
  • "total": 0
}

Узнать информацию об уценке и основном товаре по SKU уценённого товара

post
/v1/product/info/discounted

Метод для получения информации о состоянии и дефектах уценённого товара по его SKU. Работает только с уценёнными товарами по схеме FBO. Также метод возвращает SKU основного товара.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
discounted_skus
required
Array of strings <int64>

Список SKU уценённых товаров.

Ответы

Response Schema: application/json
Array of objects

Информация об уценке и основном товаре.

Array ()
comment_reason_damaged
string

Комментарий к причине повреждения.

condition
string

Состояние товара — новый или Б/У.

condition_estimation
string

Состояние товара по шкале от 1 до 7:

  • 1 — удовлетворительное,
  • 2 — хорошее,
  • 3 — очень хорошее,
  • 4 — отличное,
  • 5–7 — как новый.
defects
string

Дефекты товара.

discounted_sku
integer <int64>

SKU уценённого товара.

mechanical_damage
string

Описание механического повреждения.

package_damage
string

Описание повреждения упаковки.

packaging_violation
string

Признак нарушения целостности упаковки.

reason_damaged
string

Причина повреждения.

repair
string

Признак, что товар отремонтирован.

shortage
string

Признак, что товар некомплектный.

sku
integer <int64>

SKU основного товара.

warranty_type
string

Наличие у товара действующей гарантии.

Примеры запроса

Content type
application/json
{
  • "discounted_skus": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "items": [
    • {
      }
    ]
}

Установить скидку на уценённый товар

post
/v1/product/update/discount

Метод для установки размера скидки на уценённые товары, продающиеся по схеме FBS.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
discount
required
integer <int32>

Размер скидки: от 3 до 99 процентов.

product_id
required
integer <int64>

Идентификатор товара в системе продавца — product_id.

Ответы

Response Schema: application/json
result
boolean

Результат работы метода. true, если запрос выполнен без ошибок.

Примеры запроса

Content type
application/json
{
  • "discount": 0,
  • "product_id": 0
}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Акции

Для продвижения товаров участвуйте в акциях, которые Ozon проводит для покупателей. Подробнее об акциях в Базе знаний продавца.

Список акций

get
/v1/actions

Метод для получения списка акций Ozon, в которых можно участвовать.

Подробнее об акциях Ozon

Ответы

Response Schema: application/json
Array of objects

Результаты запроса.

Array ()
id
number <double>

Идентификатор акции.

title
string

Название акции.

action_type
string

Тип акции.

description
string

Описание акции.

date_start
string

Дата начала акции.

date_end
string

Дата окончания акции.

freeze_date
string

Дата приостановки акции.

Если поле заполнено, продавец не может повышать цены, изменять список товаров и уменьшать количество единиц товаров в акции.

Продавец может понижать цены и увеличивать количество единиц товара в акции.

potential_products_count
number <double>

Количество товаров, доступных для акции.

participating_products_count
number <double>

Количество товаров, которые участвуют в акции.

is_participating
boolean

Участвуете вы в этой акции или нет.

is_voucher_action
boolean

Признак, что для участия в акции покупателям нужен промокод.

banned_products_count
number <double>

Количество заблокированных товаров.

with_targeting
boolean

Признак, что акция с целевой аудиторией.

order_amount
number <double>

Сумма заказа.

discount_type
string

Тип скидки.

discount_value
number <double>

Размер скидки.

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Список доступных для акции товаров

post
/v1/actions/candidates

Метод для получения списка товаров, которые могут участвовать в акции, по её идентификатору.

Request Body schema: application/json
action_id
required
number <double>

Идентификатор акции. Можно получить с помощью метода /v1/actions.

limit
number <double>

Количество ответов на странице. По умолчанию — 100.

offset
required
number <double>
Deprecated

Количество элементов, которое будет пропущено в ответе. Например, если offset=10, ответ начнётся с 11-го найденного элемента.

last_id
number <double>

Идентификатор последнего значения на странице. При первом запросе оставьте это поле пустым.

Ответы

Response Schema: application/json
object

Результаты запроса.

Array of objects

Список товаров.

total
number <double>

Общее количество товаров, которое доступно для акции.

last_id
number <double>

Идентификатор последнего значения на странице. Чтобы получить следующие значения, передайте полученное значение в следующем запросе в параметре last_id.

Примеры запроса

Content type
application/json
{
  • "action_id": 63337,
  • "limit": 10,
  • "offset": 0,
  • "last_id": "bnVсbA=="
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "products": [
      • {
        },
      • {
        }
      ],
    }
}

Список участвующих в акции товаров

post
/v1/actions/products

Метод для получения списка товаров, участвующих в акции, по её идентификатору.

Request Body schema: application/json
action_id
required
number <double>

Идентификатор акции. Можно получить с помощью метода /v1/actions.

limit
number <double>

Количество ответов на странице. По умолчанию — 100.

offset
required
number <double>
Deprecated

Количество элементов, которое будет пропущено в ответе. Например, если offset=10, ответ начнётся с 11-го найденного элемента.

last_id
number <double>

Идентификатор последнего значения на странице. При первом запросе оставьте это поле пустым.

Ответы

Response Schema: application/json
object

Результаты запроса.

Array of objects

Список товаров.

total
number <double>

Общее количество товаров, которое доступно для акции.

last_id
number <double>

Идентификатор последнего значения на странице. Чтобы получить следующие значения, передайте полученное значение в следующем запросе в параметре last_id.

Примеры запроса

Content type
application/json
{
  • "action_id": 66011,
  • "limit": 10,
  • "offset": 0,
  • "last_id": "bnVсbA=="
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "products": [
      • {
        }
      ],
    }
}

Добавить товар в акцию

post
/v1/actions/products/activate

Метод для добавления товаров в доступную акцию.

Request Body schema: application/json
action_id
required
number <double>

Идентификатор акции. Можно получить с помощью метода /v1/actions.

required
Array of objects

Список товаров.

Ответы

Response Schema: application/json
object

Результаты запроса.

product_ids
Array of numbers <double>

Список идентификаторов товаров, которые добавлены в акцию.

Array of objects

Список товаров, которые не удалось добавить в акцию.

Примеры запроса

Content type
application/json
{
  • "action_id": 60564,
  • "products": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "product_ids": [
      ],
    }
}

Удалить товары из акции

post
/v1/actions/products/deactivate

Метод для удаления товаров из акции.

Request Body schema: application/json
action_id
required
number <double>

Идентификатор акции. Можно получить с помощью метода /v1/actions.

product_ids
required
Array of numbers <double>

Список идентификаторов товаров в системе продавца — product_id.

Ответы

Response Schema: application/json
object

Результаты запроса.

product_ids
Array of numbers <double>

Список идентификаторов товаров, которые удалены из акции.

Array of objects

Список товаров, которые не удалось удалить из акции.

Примеры запроса

Content type
application/json
{
  • "action_id": 66011,
  • "product_ids": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "product_ids": [
      ],
    }
}

Список заявок на скидку

post
/v1/actions/discounts-task/list

Метод для получения списка товаров, которые покупатели хотят купить со скидкой.

Request Body schema: application/json
status
required
string
Default: "UNKNOWN"
Enum: "NEW" "SEEN" "APPROVED" "PARTLY_APPROVED" "DECLINED" "AUTO_DECLINED" "DECLINED_BY_USER" "COUPON" "PURCHASED"

Статус заявки на скидку:

  • NEW — новая,
  • SEEN — просмотренная,
  • APPROVED — одобренная,
  • PARTLY_APPROVED — одобренная частично,
  • DECLINED — отклонённая,
  • AUTO_DECLINED — отклонена автоматически,
  • DECLINED_BY_USER — отклонена покупателем,
  • COUPON — скидка по купону,
  • PURCHASED — купленная.
page
integer <uint64>

Страница, с которой нужно выгрузить список заявок на скидку.

limit
required
integer <uint64>

Максимальное количество заявок на странице.

Ответы

Response Schema: application/json
Array of objects

Список заявок.

Array ()
id
integer <uint64>

Идентификатор заявки.

created_at
string <date-time>

Дата создания заявки.

end_at
string <date-time>

Время окончания действия заявки.

edited_till
string <date-time>

Время для изменения решения.

status
string

Статус заявки.

customer_name
string

Имя покупателя.

sku
integer <uint64>

Идентификатор товара в системе Ozon — SKU.

user_comment
string

Комментарий покупателя к заявке.

seller_comment
string

Комментарий продавца к заявке.

requested_price
number <double>

Цена по заявке.

approved_price
number <double>

Одобренная цена.

original_price
number <double>

Цена товара до всех скидок.

discount
number <double>

Скидка в рублях.

discount_percent
number <double>

Скидка в процентах.

base_price
number <double>

Базовая цена, по которой товар продаётся на Ozon, если не участвует в акции.

min_auto_price
number <double>

Минимальное значение цены после автоприменения скидок и акций.

prev_task_id
integer <uint64>

Идентификатор предыдущей заявки от покупателя по этому товару.

is_damaged
boolean

Является ли товар уценённым. true, если уценённый.

moderated_at
string <date-time>

Дата модерации: просмотра, одобрения или отклонения заявки.

approved_discount
number <double>

Скидка в рублях, которую одобрил продавец. Передайте значение 0, если продавец не одобрял заявку.

approved_discount_percent
number <double>

Скидка в процентах, которую одобрил продавец. Передайте значение 0, если продавец не одобрял заявку.

is_purchased
boolean

Покупал ли пользователь товар. true, если покупал.

is_auto_moderated
boolean

Была ли заявка промодерирована автоматически. true, если модерация была автоматической.

offer_id
string

Идентификатор товара в системе продавца — артикул.

email
string

Электронный адрес сотрудника продавца, который обработал заявку.

last_name
string

Фамилия сотрудника продавца, который обработал заявку.

first_name
string

Имя сотрудника продавца, который обработал заявку.

patronymic
string

Отчество сотрудника продавца, который обработал заявку.

approved_quantity_min
integer <uint64>

Минимальное одобренное количество товаров.

approved_quantity_max
integer <uint64>

Максимальное одобренное количество товаров.

requested_quantity_min
integer <uint64>

Запрошенное минимальное количество товаров.

requested_quantity_max
integer <uint64>

Запрошенное максимальное количество товаров.

requested_price_with_fee
number <double>

Цена по заявке c региональной наценкой.

approved_price_with_fee
number <double>

Одобренная цена с региональной наценкой.

approved_price_fee_percent
number <double>

Региональная наценка в процентах.

Примеры запроса

Content type
application/json
{
  • "status": "UNKNOWN",
  • "page": 0,
  • "limit": 0
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Согласовать заявку на скидку

post
/v1/actions/discounts-task/approve

Вы можете согласовывать заявки в статусах: NEW — новые, SEEN — просмотренные.

Request Body schema: application/json
required
Array of objects

Список заявок.

Ответы

Response Schema: application/json
object

Результат работы метода.

Array of objects

Ошибки при создании заявки.

success_count
integer <int32>

Количество заявок с успешной сменой статуса.

fail_count
integer <int32>

Количество заявок, у которых не удалось сменить статус.

Примеры запроса

Content type
application/json
{
  • "tasks": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "fail_details": [
      • {
        }
      ],
    }
}

Отклонить заявку на скидку

post
/v1/actions/discounts-task/decline

Вы можете отклонить заявки в статусах: NEW — новые, SEEN — просмотренные.

Request Body schema: application/json
required
Array of objects

Список заявок.

Ответы

Response Schema: application/json
object

Результат работы метода.

Array of objects

Ошибки при создании заявки.

success_count
integer <int32>

Количество заявок с успешной сменой статуса.

fail_count
integer <int32>

Количество заявок, у которых не удалось сменить статус.

Примеры запроса

Content type
application/json
{
  • "tasks": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "fail_details": [
      • {
        }
      ],
    }
}

Стратегии ценообразования

Список конкурентов

post
/v1/pricing-strategy/competitors/list

Метод для получения списка конкурентов — продавцов с похожими товарами в других интернет-магазинах и маркетплейсах.

Request Body schema: application/json
page
required
integer <int64>

Страница списка, с которой нужно выгрузить конкурентов. Минимальное значение — 1.

limit
required
integer <int64>

Максимальное количество конкурентов на странице. Допустимы значения от 1 до 50.

Ответы

Response Schema: application/json
Array of objects

Список конкурентов.

total
integer <int32>

Общее количество конкурентов.

Примеры запроса

Content type
application/json
{
  • "page": 1,
  • "limit": 20
}

Примеры ответа

Content type
application/json
{
  • "competitor": [
    • {
      }
    ],
  • "total": 0
}

Список стратегий

post
/v1/pricing-strategy/list
Request Body schema: application/json
page
required
integer <int64>

Страница списка, с которой нужно выгрузить стратегии. Минимальное значение — 1.

limit
required
integer <int64>

Максимальное количество стратегий на странице. Допустимые значения — от 1 до 50.

Ответы

Response Schema: application/json
Array of objects

Список стратегий.

total
integer <int32>

Общее количество стратегий.

Примеры запроса

Content type
application/json
{
  • "page": 1,
  • "limit": 20
}

Примеры ответа

Content type
application/json
{
  • "strategies": [
    • {
      }
    ],
  • "total": 0
}

Создать стратегию

post
/v1/pricing-strategy/create
Request Body schema: application/json
required
Array of objects

Список конкурентов.

strategy_name
required
string

Название стратегии.

Ответы

Response Schema: application/json
object

Результат работы метода.

strategy_id
string

Идентификатор стратегии.

Примеры запроса

Content type
application/json
{
  • "strategy_name": "Новая стратегия",
  • "competitors": [
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ],
  • "company_id": 7
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Информация о стратегии

post
/v1/pricing-strategy/info
Request Body schema: application/json
strategy_id
required
string

Идентификатор стратегии.

Ответы

Response Schema: application/json
object

Результат работы метода.

Array of objects

Список конкурентов.

enabled
boolean

Статус стратегии:

  • true — включена,
  • false — отключена.
name
string

Название стратегии.

type
string

Тип стратегии:

  • MIN_EXT_PRICE — системная стратегия,
  • COMP_PRICE — пользовательская стратегия.
update_type
string

Тип последнего изменения стратегии:

  • strategyEnabled — возобновлена,
  • strategyDisabled — остановлена,
  • strategyChanged — обновлена,
  • strategyCreated — создана,
  • strategyItemsListChanged — изменён набор товаров в стратегии.

Примеры запроса

Content type
application/json
{
  • "strategy_id": "string"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "competitors": [
      • {
        },
      • {
        }
      ]
    }
}

Обновить стратегию

post
/v1/pricing-strategy/update

Можно обновить все стратегии кроме системной.

Request Body schema: application/json
required
Array of objects

Список конкурентов.

strategy_id
required
string

Идентификатор стратегии.

strategy_name
required
string

Название стратегии.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "strategy_id": "a3de1826-9c54-40f1-bb6d-1a9e2638b058",
  • "strategy_name": "Новая стратегия",
  • "competitors": [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{ }

Добавить товары в стратегию

post
/v1/pricing-strategy/products/add
Request Body schema: application/json
product_id
required
Array of strings <int64>

Список идентификаторов товаров в системе продавца — product_id. Максимальное количество — 50.

strategy_id
required
string

Идентификатор стратегии.

Ответы

Response Schema: application/json
object

Результат работы метода.

Array of objects

Товары с ошибками.

failed_product_count
integer <int32>

Количество товаров с ошибками.

Примеры запроса

Content type
application/json
{
  • "product_id": [
    ],
  • "strategy_id": "e29114f0-177d-4160-8d06-2bc528470dda"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Список идентификаторов стратегий

post
/v1/pricing-strategy/strategy-ids-by-product-ids
Request Body schema: application/json
product_id
required
Array of strings <int64>

Список идентификаторов товаров в системе продавца — product_id. Максимальное количество — 50.

Ответы

Response Schema: application/json
object

Результат работы метода.

Array of objects

Информация о товаре.

Примеры запроса

Content type
application/json
{
  • "product_id": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "products_info": [
      • {
        }
      ]
    }
}

Список товаров в стратегии

post
/v1/pricing-strategy/products/list
Request Body schema: application/json
strategy_id
required
string

Идентификатор стратегии.

Ответы

Response Schema: application/json
object

Список товаров.

product_id
Array of strings <int64>

Идентификатор товара в системе продавца — product_id.

Примеры запроса

Content type
application/json
{
  • "strategy_id": "string"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "product_id": [
      ]
    }
}

Цена товара у конкурента

post
/v1/pricing-strategy/product/info

Если вы добавили товар в стратегию ценообразования, метод вернёт цену и ссылку на товар у конкурента.

Request Body schema: application/json
product_id
required
integer <int64>

Идентификатор товара в системе продавца — product_id.

Ответы

Response Schema: application/json
object

Результат работы метода.

strategy_id
string

Идентификатор стратегии.

is_enabled
boolean

true, если товар участвует в стратегии ценообразования.

strategy_product_price
integer <int32>

Цена по стратегии.

price_downloaded_at
string

Дата установки цены по стратегии.

strategy_competitor_id
integer <int64>

Идентификатор конкурента.

strategy_competitor_product_url
string

Ссылка на товар конкурента.

Примеры запроса

Content type
application/json
{
  • "product_id": 0
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Удалить товары из стратегии

post
/v1/pricing-strategy/products/delete
Request Body schema: application/json
product_id
required
Array of strings <int64>

Список идентификаторов товаров в системе продавца — product_id. Максимальное количество — 50.

Ответы

Response Schema: application/json
object

Результат работы метода.

failed_product_count
integer <int32>

Количество товаров с ошибками.

Примеры запроса

Content type
application/json
{
  • "product_id": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Изменить статус стратегии

post
/v1/pricing-strategy/status

Можно изменить статус любой стратегии кроме системной.

Request Body schema: application/json
enabled
boolean

Статус стратегии:

  • true — включена,
  • false — отключена.
strategy_id
required
string

Идентификатор стратегии.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "strategy_id": "c7516438-7124-4e2c-85d3-ccd92b6b9b65",
  • "enabled": true
}

Примеры ответа

Content type
application/json
{ }

Удалить стратегию

post
/v1/pricing-strategy/delete

Можно удалить любую стратегию кроме системной.

Request Body schema: application/json
strategy_id
required
string

Идентификатор стратегии.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "strategy_id": "string"
}

Примеры ответа

Content type
application/json
{ }

Сертификаты брендов

Список сертифицируемых брендов

post
/v1/brand/company-certification/list

Метод для получения списка брендов, для которых требуется предоставить сертификат. Ответ содержит список брендов, товары которых есть в вашем личном кабинете.

Список брендов может изменяться, если Ozon получит требование от бренда предоставлять сертификат.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
page
required
integer <int32>

Номер страницы, возвращаемой в запросе.

page_size
required
integer <int32>

Количество элементов на странице.

Ответы

Response Schema: application/json
object

Результат запроса.

Array of objects

Информация о сертифицируемых брендах.

total
integer <int64>

Общее количество брендов.

Примеры запроса

Content type
application/json
{
  • "page": 0,
  • "page_size": 0
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "brand_certification": [
      • {
        }
      ],
    }
}

Сертификаты качества

Список типов соответствия требованиям (версия 1)

get
/v1/product/certificate/accordance-types
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Ответы

Response Schema: application/json
Array of objects

Список типов и названий сертификатов.

Array ()
name
string

Название документа.

value
string

Значение справочника.

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      },
    • {
      },
    • {
      }
    ]
}

Список типов соответствия требованиям (версия 2)

get
/v2/product/certificate/accordance-types/list

Ответы

Response Schema: application/json
object

Список типов соответствия требованиям.

Array of objects

Основные типы соответствия требованиям.

Array of objects

Типов соответствия требованиям, относящиеся к опасным товарам.

Примеры ответа

Content type
application/json
{
  • "result": {
    • "base": [
      • {
        }
      ],
    • "hazard": [
      • {
        }
      ]
    }
}

Справочник типов документов

get
/v1/product/certificate/types
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Ответы

Response Schema: application/json
Array of objects

Список типов и названий сертификатов.

Array ()
name
string

Название документа.

value
string

Значение справочника.

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
}

Список сертифицируемых категорий

post
/v2/product/certification/list
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
page
required
integer <int64>

Номер страницы.

page_size
required
integer <int64> [ 1 .. 1000 ]

Количество элементов на странице.

Ответы

Response Schema: application/json
Array of objects

Информация о сертифицируемых категориях.

total
integer <int64>

Всего категорий.

Примеры запроса

Content type
application/json
{
  • "page": 0,
  • "page_size": 1
}

Примеры ответа

Content type
application/json
{
  • "certification": [
    • {
      }
    ],
  • "total": 0
}

Список сертифицируемых категорий

post
/v1/product/certification/list
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
page
integer <int32>

Номер страницы, возвращаемой в запросе.

page_size
integer <int32>

Количество элементов на странице.

Ответы

Response Schema: application/json
object

Результат запроса.

Array of objects

Информация о сертифицируемых категориях.

total
integer <int64>

Всего категорий.

Примеры запроса

Content type
application/json
{
  • "page": 1,
  • "page_size": 100
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "certification": [
      • {
        }
      ],
    }
}

Добавить сертификаты для товаров

post
/v1/product/certificate/create
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: multipart/form-data
files
required
Array of file

Массив сертификатов для товара. Допустимые расширения jpg, jpeg, png, pdf.

name
required
string

Название сертификата. Максимум 100 символов.

number
required
string

Номер сертификата. Максимум 100 символов.

type_code
required
string
Enum: "certificate_of_conformity" "declaration" "certificate_of_registration" "registration_certificate" "refused_letter"

Тип сертификата. Чтобы получить доступные типы, используйте метод GET /v1/product/certificate/types.

accordance_type_code
string
Enum: "technical_regulations_rf" "technical_regulations_cu" "gost"

Тип соответствия требованиям. Чтобы получить доступные типы, используйте метод GET /v1/product/certificate/accordance-types.

issue_date
required
string <date-time>
Default: "2021-04-30T11:31:26Z"

Дата начала действия сертификата.

expire_date
string <date-time>

Дата окончания действия сертификата. Может быть пустым для бессрочных сертификатов.

Формат: 2021-04-30T11:31:26Z.

Ответы

Response Schema: application/json
integer

Примеры ответа

Content type
application/json
{
  • "id": 50058
}

Привязать сертификат к товару

post
/v1/product/certificate/bind
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
certificate_id
integer <int64>

Идентификатор сертификата, который был присвоен при его загрузке.

product_id
Array of integers <int64>

Массив идентификаторов товаров, к которым относится этот сертификат.

Ответы

Response Schema: application/json
result
boolean

Результат обработки запроса. true, если запрос выполнен без ошибок.

Примеры запроса

Content type
application/json
{
  • "certificate_id": 50058,
  • "product_id": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Удалить сертификат

post
/v1/product/certificate/delete
Request Body schema: application/json
certificate_id
required
integer <int32>

Идентификатор сертификата.

Ответы

Response Schema: application/json
object

Результат удаления сертификата.

is_delete
boolean

Удалён ли сертификат:

  • true — удалён,
  • false — не удалён.
error_message
string

Описание ошибок при удалении сертификата.

Примеры запроса

Content type
application/json
{
  • "certificate_id": 0
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Информация о сертификате

post
/v1/product/certificate/info
Request Body schema: application/json
certificate_number
required
string

Идентификатор сертификата.

Ответы

Response Schema: application/json
object

Информация о сертификате.

certificate_id
integer <int32>

Идентификатор.

certificate_number
string

Номер.

certificate_name
string

Название.

type_code
string

Тип.

status_code
string

Статус.

accordance_type_code
string

Тип соответствия требованиям.

rejection_reason_code
string

Причина отклонения сертификата.

verification_comment
string

Комментарий модератора.

issue_date
string <date-time>

Дата создания.

expire_date
string <date-time>

Дата окончания действия.

products_count
integer <int32>

Количество товаров, привязанных к сертификату.

Примеры запроса

Content type
application/json
{
  • "certificate_number": "string"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Список сертификатов

post
/v1/product/certificate/list
Request Body schema: application/json
offer_id
string

Идентификатор товара в системе продавца — артикул, привязанный к сертификату. Передайте параметр, если нужны сертификаты, к которым привязаны определённые товары.

status
string

Статус сертификата. Передайте параметр, если нужны сертификаты с определённым статусом.

type
string

Тип сертификата. Передайте параметр, если нужны сертификаты с определённым типом.

page
required
integer <int32>

Страница, с которой следует выводить список. Минимальное значение — 1.

page_size
required
integer <int32>

Количество объектов на странице. Значение — от 1 до 1000.

Ответы

Response Schema: application/json
object

Список сертификатов.

Array of objects

Информация о сертификате.

page_count
integer <int32>

Количество страниц.

Примеры запроса

Content type
application/json
{
  • "offer_id": "string",
  • "status": "string",
  • "type": "string",
  • "page": 0,
  • "page_size": 0
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "certificates": [
      • {
        }
      ],
    }
}

Список возможных статусов товаров

post
/v1/product/certificate/product_status/list

Метод для получения списка возможных статусов товаров при их привязке к сертификату.

Request Body schema: application/json
object

Ответы

Response Schema: application/json
Array of objects

Список статусов товаров.

Array ()
code
string

Код статуса товара при привязке к сертификату.

name
string

Описание статуса.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Список товаров, привязанных к сертификату

post
/v1/product/certificate/products/list
Request Body schema: application/json
certificate_id
required
integer <int32>

Идентификатор сертификата.

product_status_code
string

Статус проверки товара при привязке к сертификату.

page
required
integer <int32>

Номер страницы, с которой выводить список. Минимальное значение — 1.

page_size
required
integer <int32>

Количество объектов на странице. Значение — от 1 до 1000.

Ответы

Response Schema: application/json
object

Товары, привязанные к сертификату.

Array of objects

Список товаров.

count
integer <int64>

Количество найденных товаров.

Примеры запроса

Content type
application/json
{
  • "certificate_id": 0,
  • "product_status_code": "string",
  • "page": 0,
  • "page_size": 0
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "items": [
      • {
        }
      ],
    }
}

Отвязать товар от сертификата

post
/v1/product/certificate/unbind
Request Body schema: application/json
certificate_id
required
integer <int32>

Идентификатор сертификата.

product_id
required
Array of strings <int64>

Список идентификаторов товара, которые нужно отвязать от сертификата.

Ответы

Response Schema: application/json
Array of objects

Результат работы метода.

Array ()
error
string

Сообщение об ошибке при отвязывании товара.

product_id
integer <int64>

Идентификатор товара в системе продавца — product_id.

updated
boolean

Был ли отвязан товар от сертификата:

  • true — отвязан,
  • false — не отвязан.

Примеры запроса

Content type
application/json
{
  • "certificate_id": 0,
  • "product_id": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Возможные причины отклонения сертификата

post
/v1/product/certificate/rejection_reasons/list
Request Body schema: application/json
object

Ответы

Response Schema: application/json
Array of objects

Причины отклонения сертификата.

Array ()
code
string

Код причины отклонения сертификата.

name
string

Описание причины отклонения сертификата.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Возможные статусы сертификатов

post
/v1/product/certificate/status/list
Request Body schema: application/json
object

Ответы

Response Schema: application/json
Array of objects

Список возможных статусов сертификатов.

Array ()
code
string

Код статуса сертификата.

name
string

Описание статуса.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Склады

Список складов

post
/v1/warehouse/list

Метод возвращает список складов FBS и rFBS. Чтобы получить список складов FBO, используйте метод /v1/cluster/list.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Ответы

Response Schema: application/json
Array of objects

Список складов.

Array ()
has_entrusted_acceptance
boolean

Признак доверительной приёмки. true, если доверительная приёмка включена на складе.

is_rfbs
boolean

Признак работы склада по схеме rFBS:

  • true — склад работает по схеме rFBS;
  • false — не работает по схеме rFBS.
name
string

Название склада.

warehouse_id
integer <int64>

Идентификатор склада.

can_print_act_in_advance
boolean

Возможность печати акта приёма-передачи заранее. true, если печатать заранее возможно.

object

Первая миля FBS.

has_postings_limit
boolean

Признак наличия лимита минимального количества заказов. true, если лимит есть.

is_karantin
boolean

Признак, что склад не работает из-за карантина.

is_kgt
boolean

Признак, что склад принимает крупногабаритные товары.

is_economy
boolean

true, если склад работает с эконом-товарами.

is_timetable_editable
boolean

Признак, что можно менять расписание работы складов.

min_postings_limit
integer <int32>

Минимальное значение лимита — количество заказов, которые можно привезти в одной поставке.

postings_limit
integer <int32>

Значение лимита. -1, если лимита нет.

min_working_days
integer <int64>

Количество рабочих дней склада.

status
string

Статус склада.

Соответствие статусов склада со статусами с личном кабинете:

Статус Seller API Статус в личном кабинете
new Активируется
created Активный
disabled В архиве
blocked Заблокирован
disabled_due_to_limit На паузе
error Ошибка
working_days
Array of strings
Items Enum: "1" "2" "3" "4" "5" "6" "7"

Рабочие дни склада.

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "first_mile_type": {
        },
      • "working_days": [
        ]
      }
    ]
}

Список методов доставки склада

post
/v1/delivery-method/list
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Фильтр для поиска методов доставки.

limit
required
integer <int64>

Количество элементов в ответе. Максимум — 50, минимум — 1.

offset
integer <int64>

Количество элементов, которое будет пропущено в ответе. Например, если offset = 10, то ответ начнётся с 11-го найденного элемента.

Ответы

Response Schema: application/json
has_next
boolean

Признак, что в запросе вернулась только часть методов доставки:

  • true — сделайте повторный запрос с новым параметром offset для получения остальных методов;
  • false — ответ содержит все методы доставки по запросу.
Array of objects

Результат запроса.

Array ()
company_id
integer <int64>

Идентификатор продавца.

created_at
string <date-time>

Дата и время создания метода доставки.

cutoff
string

Время, до которого продавцу нужно собрать заказ.

id
integer <int64>

Идентификатор метода доставки.

name
string

Название метода доставки.

provider_id
integer <int64>

Идентификатор службы доставки.

sla_cut_in
integer <int64>

Минимальное время на сборку заказа в минутах в соответствии с настройками склада.

status
string

Статус метода доставки:

  • NEW — создан,
  • EDITED — редактируется,
  • ACTIVE — активный,
  • DISABLED — неактивный.
template_id
integer <int64>

Идентификатор услуги по доставке заказа.

updated_at
string <date-time>

Дата и время последнего обновления метода метода доставки.

warehouse_id
integer <int64>

Идентификатор склада.

Примеры запроса

Content type
application/json
{
  • "filter": {
    },
  • "limit": 100,
  • "offset": 0
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ],
  • "has_next": false
}

Обработка заказов FBS и rFBS

Список необработанных отправлений (версия 3)

post
/v3/posting/fbs/unfulfilled/list

Возвращает список необработанных отправлений за указанный период времени — он должен быть не больше одного года.

Возможные статусы отправлений:

  • awaiting_registration — ожидает регистрации,
  • acceptance_in_progress — идёт приёмка,
  • awaiting_approve — ожидает подтверждения,
  • awaiting_packaging — ожидает упаковки,
  • awaiting_deliver — ожидает отгрузки,
  • arbitration — арбитраж,
  • client_arbitration — клиентский арбитраж доставки,
  • delivering — доставляется,
  • driver_pickup — у водителя,
  • cancelled — отменено,
  • not_accepted — не принят на сортировочном центре,
  • sent_by_seller — отправлено продавцом.

Чтобы получать актуальную дату отгрузки, регулярно обновляйте информацию об отправлениях или подключите пуш-уведомления.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
dir
string

Направление сортировки:

  • asc — по возрастанию,
  • desc — по убыванию.
required
object

Фильтр запроса.

Используйте фильтр либо по времени сборки — cutoff, либо по дате передачи отправления в доставку — delivering_date. Если использовать их вместе, в ответе вернётся ошибка.

Чтобы использовать фильтр по времени сборки, заполните поля cutoff_from и cutoff_to.

Чтобы использовать фильтр по дате передачи отправления в доставку, заполните поля delivering_date_from и delivering_date_to.

limit
required
integer <int64>

Количество значений в ответе:

  • максимум — 1000,
  • минимум — 1.
offset
required
integer <int64>

Количество элементов, которое будет пропущено в ответе. Например, если offset = 10, то ответ начнётся с 11-го найденного элемента.

object

Дополнительные поля, которые нужно добавить в ответ.

Ответы

Response Schema: application/json
object

Результат запроса.

count
integer <int64>

Счётчик элементов в ответе.

Array of objects

Список отправлений и подробная информация по каждому.

Примеры запроса

Content type
application/json
{
  • "dir": "ASC",
  • "filter": {
    },
  • "limit": 100,
  • "offset": 0,
  • "with": {
    }
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "postings": [
      • {
        • "delivery_method": {
          },
        • "optional": {
          • "products_with_possible_mandatory_mark": [
            ]
          },
        • "cancellation": {
          },
        • "products": [
          • {
            }
          ],
        • "barcodes": {
          },
        • "analytics_data": {
          },
        • "financial_data": {
          • "products": [
            • {
              • "actions": [
                ],
              }
            ]
          },
        • "requirements": {
          },
        • "tariffication": [
          • {
            }
          ]
        }
      ],
    }
}

Список отправлений (версия 3)

post
/v3/posting/fbs/list

Возвращает список отправлений за указанный период времени — он должен быть не больше одного года.

Дополнительно можно отфильтровать отправления по их статусу — список доступных для выдачи статусов указан в описании параметра filter.status.

has_next = true в ответе может значить, что вернули не весь массив отправлений. Чтобы получить информацию об остальных отправлениях, сделайте новый запрос с другим значением offset.

Чтобы получать актуальную дату отгрузки, регулярно обновляйте информацию об отправлениях или подключите пуш-уведомления.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
dir
string

Направление сортировки:

  • asc — по возрастанию,
  • desc — по убыванию.
required
object

Фильтр.

limit
required
integer <int64>

Количество значений в ответе:

  • максимум — 1000,
  • минимум — 1.
offset
required
integer <int64>

Количество элементов, которое будет пропущено в ответе. Например, если offset = 10, то ответ начнётся с 11-го найденного элемента.

object

Дополнительные поля, которые нужно добавить в ответ.

Ответы

Response Schema: application/json
object

Массив отправлений.

has_next
boolean

Признак, что в ответе вернули не весь массив отправлений:

  • true — необходимо сделать новый запрос с другим значением offset, чтобы получить информацию об остальных отправлениях;
  • false — в ответе вернули весь массив отправлений для фильтра, который был задан в запросе.
Array of objects

Информация об отправлении.

Примеры запроса

Content type
application/json
{
  • "dir": "ASC",
  • "filter": {
    • "delivery_method_id": [
      ],
    • "last_changed_status_date": {
      },
    • "provider_id": [
      ],
    • "warehouse_id": [
      ]
    },
  • "limit": 0,
  • "offset": 0,
  • "with": {
    }
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "postings": [
      • {
        • "delivery_method": {
          },
        • "optional": {
          • "products_with_possible_mandatory_mark": [
            ]
          },
        • "cancellation": {
          },
        • "products": [
          • {
            }
          ],
        • "requirements": {
          },
        • "tariffication": [
          • {
            }
          ]
        }
      ],
    }
}

Получить информацию об отправлении по идентификатору

post
/v3/posting/fbs/get

Чтобы получать актуальную дату отгрузки, регулярно обновляйте информацию об отправлениях или подключите пуш-уведомления.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
string

Идентификатор отправления.

object

Дополнительные поля, которые нужно добавить в ответ.

Ответы

Response Schema: application/json
object

Информация об отправлении.

Array of objects
object

Контактные данные получателя.

object

Данные аналитики.

available_actions
Array of strings

Доступные действия и информация об отправлении:

  • arbitration — открыть спор;
  • awaiting_delivery — перевести в статус «Ожидает отгрузки»;
  • can_create_chat — начать чат с покупателем;
  • cancel — отменить отправление;
  • click_track_number — просмотреть по трек-номеру историю изменения статусов в личном кабинете;
  • customer_phone_available — телефон покупателя;
  • has_weight_products — весовые товары в отправлении;
  • hide_region_and_city — скрыть регион и город покупателя в отчёте;
  • invoice_get — получить информацию из счёта-фактуры;
  • invoice_send — создать счёт-фактуру;
  • invoice_update — отредактировать счёт-фактуру;
  • label_download_big — скачать большую этикетку;
  • label_download_small — скачать маленькую этикетку;
  • label_download — скачать этикетку;
  • non_int_delivered — перевести в статус «Условно доставлен»;
  • non_int_delivering — перевести в статус «Доставляется»;
  • non_int_last_mile — перевести в статус «Курьер в пути»;
  • product_cancel — отменить часть товаров в отправлении;
  • set_cutoff — необходимо указать дату отгрузки, воспользуйтесь методом /v1/posting/cutoff/set;
  • set_timeslot — изменить время доставки покупателю;
  • set_track_number — указать или изменить трек-номер;
  • ship_async_in_process — отправление собирается;
  • ship_async_retry — собрать отправление повторно после ошибки сборки;
  • ship_async — собрать отправление;
  • ship_with_additional_info — необходимо заполнить дополнительную информацию;
  • ship — собрать отправление;
  • update_cis — изменить дополнительную информацию.
object

Штрихкоды отправления.

object

Информация об отмене.

object

Данные о курьере.

object

Данные о покупателе.

delivering_date
string <date-time>

Дата передачи отправления в доставку.

object

Метод доставки.

delivery_price
string

Стоимость доставки.

object

Данные о стоимости товара, размере скидки, выплате и комиссии.

in_process_at
string <date-time>

Дата и время начала обработки отправления.

is_express
boolean

Если использовалась быстрая доставка Ozon Express — true.

is_multibox
boolean

Признак, что в отправлении есть многокоробочный товар и нужно передать количество коробок для него:

  • true — до сборки передайте количество коробок через метод /v3/posting/multiboxqty/set.
  • false — отправление собрано с указанием количества коробок в параметре multi_box_qty или в отправлении нет многокоробочного товара.
multi_box_qty
integer <int32>

Количество коробок, в которые упакован товар.

object

Список товаров с дополнительными характеристиками.

order_id
integer <int64>

Идентификатор заказа, к которому относится отправление.

order_number
string

Номер заказа, к которому относится отправление.

parent_posting_number
string

Номер родительского отправления, в результате разделения которого появилось текущее.

pickup_code_verified_at
string <date-time>

Дата и время успешной валидации кода курьера. Чтобы проверить код курьера, воспользуйтесь методом /v1/posting/fbs/pick-up-code/verify.

posting_number
string

Номер отправления.

object

Информация по продуктам и их экзмеплярам.

Ответ содержит поле product_exemplars, если в запросе передан признак with.product_exemplars = true.

Array of objects

Массив товаров в отправлении.

provider_status
string

Статус службы доставки.

object

Информация об услуге погрузочно-разгрузочных работ. Актуально для КГТ-отправлений с доставкой силами продавца или интегрированной службой.

object

Связанные отправления.

object

Cписок продуктов, для которых нужно передать страну-изготовителя, номер грузовой таможенной декларации (ГТД), регистрационный номер партии товара (РНПТ) или маркировку «Честный ЗНАК», чтобы перевести отправление в следующий статус.

shipment_date
string <date-time>

Дата и время, до которой необходимо собрать отправление. Если отправление не собрать к этой дате — оно автоматически отменится.

status
string

Статус отправления:

  • acceptance_in_progress — идёт приёмка,
  • arbitration — арбитраж,
  • awaiting_approve — ожидает подтверждения,
  • awaiting_deliver — ожидает отгрузки,
  • awaiting_packaging — ожидает упаковки,
  • awaiting_registration — ожидает регистрации,
  • awaiting_verification — создано,
  • cancelled — отменено,
  • cancelled_from_split_pending — отменён из-за разделения отправления,
  • client_arbitration — клиентский арбитраж доставки,
  • delivered — доставлено,
  • delivering — доставляется,
  • driver_pickup — у водителя,
  • not_accepted — не принят на сортировочном центре,
  • sent_by_seller – отправлено продавцом.
substatus
string

Подстатус отправления:

  • posting_acceptance_in_progress — идёт приёмка,
  • posting_in_arbitration — арбитраж,
  • posting_created — создано,
  • posting_in_carriage — в перевозке,
  • posting_not_in_carriage — не добавлено в перевозку,
  • posting_registered — зарегистрировано,
  • posting_transferring_to_delivery (status=awaiting_deliver) — передаётся в доставку,
  • posting_awaiting_passport_data — ожидает паспортных данных,
  • posting_created — создано,
  • posting_awaiting_registration — ожидает регистрации,
  • posting_registration_error — ошибка регистрации,
  • posting_transferring_to_delivery (status=awaiting_registration) — передаётся курьеру,
  • posting_split_pending — создано,
  • posting_canceled — отменено,
  • posting_in_client_arbitration — клиентский арбитраж доставки,
  • posting_delivered — доставлено,
  • posting_received — получено,
  • posting_conditionally_delivered — условно доставлено,
  • posting_in_courier_service — курьер в пути,
  • posting_in_pickup_point — в пункте выдачи,
  • posting_on_way_to_city — в пути в ваш город,
  • posting_on_way_to_pickup_point — в пути в пункт выдачи,
  • posting_returned_to_warehouse — возвращено на склад,
  • posting_transferred_to_courier_service — передаётся в службу доставки,
  • posting_driver_pick_up — у водителя,
  • posting_not_in_sort_center — не принято на сортировочном центре,
  • sent_by_seller — отправлено продавцом.
previous_substatus
string

Предыдущий подстатус отправления. Возможные значения:

  • posting_acceptance_in_progress — идёт приёмка,
  • posting_in_arbitration — арбитраж,
  • posting_created — создано,
  • posting_in_carriage — в перевозке,
  • posting_not_in_carriage — не добавлено в перевозку,
  • posting_registered — зарегистрировано,
  • posting_transferring_to_delivery (status=awaiting_deliver) — передаётся в доставку,
  • posting_awaiting_passport_data — ожидает паспортных данных,
  • posting_created — создано,
  • posting_awaiting_registration — ожидает регистрации,
  • posting_registration_error — ошибка регистрации,
  • posting_transferring_to_delivery (status=awaiting_registration) — передаётся курьеру,
  • posting_split_pending — создано,
  • posting_canceled — отменено,
  • posting_in_client_arbitration — клиентский арбитраж доставки,
  • posting_delivered — доставлено,
  • posting_received — получено,
  • posting_conditionally_delivered — условно доставлено,
  • posting_in_courier_service — курьер в пути,
  • posting_in_pickup_point — в пункте выдачи,
  • posting_on_way_to_city — в пути в ваш город,
  • posting_on_way_to_pickup_point — в пути в пункт выдачи,
  • posting_returned_to_warehouse — возвращено на склад,
  • posting_transferred_to_courier_service — передаётся в службу доставки,
  • posting_driver_pick_up — у водителя,
  • posting_not_in_sort_center — не принято на сортировочном центре,
  • sent_by_seller — отправлено продавцом.
tpl_integration_type
string

Тип интеграции со службой доставки:

  • ozon — доставка через Ozon логистику.
  • aggregator — доставка внешней службой, Ozon регистрирует заказ.
  • 3pl_tracking — доставка внешней службой, продавец регистрирует заказ.
  • non_integrated — доставка силами продавца.
tracking_number
string

Трек-номер отправления.

Array of objects

Информация по тарификации отгрузки.

Примеры запроса

Content type
application/json
{
  • "posting_number": "57195475-0050-3",
  • "with": {
    }
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "delivery_method": {
      },
    • "optional": {
      • "products_with_possible_mandatory_mark": [
        ]
      },
    • "cancellation": {
      },
    • "products": [
      • {
        • "dimensions": {
          }
        }
      ],
    • "requirements": {
      },
    • "tariffication": [
      • {
        }
      ]
    }
}

Получить информацию об отправлении по штрихкоду

post
/v2/posting/fbs/get-by-barcode
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
barcode
string

Штрихкод отправления. Можно получить с помощью методов: /v3/posting/fbs/get, /v3/posting/fbs/list и /v3/posting/fbs/unfulfilled/list в массиве barcodes.

Ответы

Response Schema: application/json
object

Результаты запроса.

object

Аналитические данные.

object

Штрихкоды отправления.

cancel_reason_id
integer <int64>

Идентификатор причины отмены отправления.

created_at
string <date-time>

Дата и время создания отправления.

object

Финансовые данные.

in_process_at
string <date-time>

Дата и время начала обработки отправления.

order_id
integer <int64>

Идентификатор заказа, к которому относится отправление.

order_number
string

Номер заказа, к которому относится отправление.

posting_number
string

Номер отправления.

Array of objects

Список товаров в отправлении.

shipment_date
string <date-time>

Дата и время, до которой необходимо собрать отправление. Если отправление не собрать к этой дате — оно автоматически отменится.

status
string

Статус отправления.

Примеры запроса

Content type
application/json
{
  • "barcode": "20325804886000"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "delivery_method": {
      },
    • "cancellation": {
      },
    • "products": [
      • {
        • "dimensions": {
          }
        }
      ],
    • "requirements": {
      },
    }
}

Указать количество коробок для многокоробочных отправлений

post
/v3/posting/multiboxqty/set

Метод для передачи количества коробок для отправлений, в которых есть многокоробочные товары.

Используйте метод при работе по схеме rFBS Агрегатор — c доставкой партнёрами Ozon.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
string

Идентификатор многокоробочного отправления.

multi_box_qty
required
integer <int64>

Количество коробок, в которые упакован товар.

Ответы

Response Schema: application/json
object

Результат передачи количества коробок.

result
boolean

Возможные значения:

  • true — значение передано успешно.
  • false — при передаче произошла ошибка. Попробуйте снова.

Примеры запроса

Content type
application/json
{
  • "posting_number": "string",
  • "multi_box_qty": 0
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Добавить вес для весовых товаров в отправлении

post
/v2/posting/fbs/product/change
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
required
Array of objects

Информация о товарах.

posting_number
required
string

Идентификатор отправления.

Ответы

Response Schema: application/json
result
string

Идентификатор отправления.

Примеры запроса

Content type
application/json
{
  • "items": [
    • {
      • "weightReal": [
        ]
      }
    ],
  • "posting_number": "33920158-0006-1"
}

Примеры ответа

Content type
application/json
{
  • "result": "33920158-0006-1"
}

Список доступных стран-изготовителей

post
/v2/posting/fbs/product/country/list

Метод для получения списка доступных стран-изготовителей и их ISO кодов.

Request Body schema: application/json
name_search
string

Фильтрация по строке.

Ответы

Response Schema: application/json
Array of objects

Список стран-изготовителей и ISO коды.

Array ()
name
string

Название страны на русском языке.

country_iso_code
string

ISO код страны.

Примеры запроса

Content type
application/json
{
  • "name_search": ""
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      },
    • {
      },
    • {
      }
    ]
}

Добавить информацию о стране-изготовителе товара

post
/v2/posting/fbs/product/country/set

Метод для добавления на продукт атрибута «Страна-изготовитель», если он не был указан.

Request Body schema: application/json
posting_number
required
string

Номер отправления.

product_id
required
integer <int64>

Идентификатор товара в системе продавца — product_id.

country_iso_code
required
string

Двухбуквенный код добавляемой страны по стандарту ISO_3166-1.

Список доступных стран-изготовителей и их ISO коды можно получить с помощью метода /v2/posting/fbs/product/country/list.

Ответы

Response Schema: application/json
product_id
integer <int64>

Идентификатор товара в системе продавца — product_id.

is_gtd_needed
boolean

Признак того, что необходимо передать номер грузовой таможенной декларации (ГТД) для продукта и отправления.

Примеры запроса

Content type
application/json
{
  • "country_iso_code": "NO",
  • "posting_number": "57195475-0050-3",
  • "product_id": 180550365
}

Примеры ответа

Content type
application/json
{
  • "product_id": 180550365,
  • "is_gtd_needed": true
}

Получить ограничения пункта приёма

post
/v1/posting/fbs/restrictions

Метод для получения габаритных, весовых и прочих ограничений пункта приёма по номеру отправления. Метод применим только для работы по схеме FBS.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
string

Номер отправления, для которого нужно определить ограничения.

Ответы

Response Schema: application/json
object
posting_number
string

Номер отправления.

max_posting_weight
number <double>

Ограничение по максимальному весу в граммах.

min_posting_weight
number <double>

Ограничение по минимальному весу в граммах.

width
number <double>

Ограничение по ширине в сантиметрах.

length
number <double>

Ограничение по длине в сантиметрах.

height
number <double>

Ограничение по высоте в сантиметрах.

max_posting_price
number <double>

Ограничение по максимальной стоимости отправления в рублях.

min_posting_price
number <double>

Ограничение по минимальной стоимости отправления в рублях.

Примеры запроса

Content type
application/json
{
  • "posting_number": "76673629-0020-1"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Напечатать этикетку

post
/v2/posting/fbs/package-label

Генерирует PDF-файл с этикетками для указанных отправлений. В одном запросе можно передать не больше 20 идентификаторов. Если хотя бы для одного отправления возникнет ошибка, этикетки не будут подготовлены для всех отправлений в запросе.

Рекомендуем запрашивать этикетки через 45–60 секунд после сборки заказа.

Ошибка The next postings aren't ready означает, что этикетки ещё не готовы, повторите запрос позднее.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
Array of strings

Идентификатор отправления.

Ответы

Response Schema: application/pdf
file_content
string <byte>

Содержание файла в бинарном виде.

file_name
string

Название файла.

content_type
string

Тип файла.

Примеры запроса

Content type
application/json
{
  • "posting_number": [
    ]
}

Примеры ответа

Content type
application/pdf
{
  "content_type": "application/pdf",
  "file_name": "ticket-170660-2023-07-13T13:17:06Z.pdf",
  "file_content": "%PDF-1.7\n%âãÏÓ\n53 0 obj\n<</MarkInfo<</Marked true/Type/MarkInfo>>/Pages 9 0 R/StructTreeRoot 10 0 R/Type/Catalog>>\nendobj\n8 0 obj\n<</Filter/FlateDecode/Length 2888>>\nstream\nxœå[[ݶ\u0011~?¿BÏ\u0005Bs†\u001c^\u0000Àwí5ú\u0010 m\u0016Èsà¦)\n;hÒ\u0014èÏïG‰\u0014)‰<{äµ] ]?¬¬oIÎ}†¤F±‰óϤñï\u001bÕü×X­´OÏï?^~¹$<ø¨È9q\u0013Y\u0012åñì§_¼|ÿ‡égü\t+\u0012\u001bxžª}Æxšҿ¿¼›–‡_º¼xg¦Ÿþ5Oku˜œÌ3ýíògüûå\"Ni\u0016C\u0001°\u000fA9g‰'r¢\"\u0013YóĪ\u0018NÑ{\u001d–ÕóZ¬\\Ô\""
}

Создать задание на формирование этикеток

post
/v2/posting/fbs/package-label/create

Метод для создания задания на асинхронное формирование этикеток. Метод может вернуть несколько заданий: на формирование маленькой и большой этикетки.

Чтобы получить созданные этикетки, используйте /v1/posting/fbs/package-label/get.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
Array of strings

Номера отправлений, для которых нужны этикетки.

Ответы

Response Schema: application/json
object

Результат работы метода.

Array of objects

Список заданий.

Примеры запроса

Content type
application/json
{
  • "posting_number": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "tasks": [
      • {
        },
      • {
        }
      ]
    }
}

Создать задание на выгрузку этикеток

post
/v1/posting/fbs/package-label/create

Метод для создания задания на асинхронное формирование этикеток.

Для получения этикеток, созданных в результате вызова метода, используйте /v1/posting/fbs/package-label/get.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
Array of strings

Номера отправлений, для которых нужны этикетки.

Ответы

Response Schema: application/json
object

Результат работы метода.

task_id
integer <int64>

Идентификатор задания на формирование этикеток.

Примеры запроса

Content type
application/json
{
  • "posting_number": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Получить файл с этикетками

post
/v1/posting/fbs/package-label/get

Метод для получения этикеток после вызова /v1/posting/fbs/package-label/create.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
task_id
required
integer <int64>

Номер задания на формирование этикеток из ответа метода /v1/posting/fbs/package-label/create.

Ответы

Response Schema: application/json
object

Результат работы метода.

error
string

Код ошибки.

file_url
string

Ссылка на файл с этикетками.

status
string

Статус формирования этикеток:

  • pending — задание в очереди.
  • in_progress — формируются.
  • completed — файл с этикетками готов.
  • error — при формировании файла произошла ошибка.

Примеры запроса

Content type
application/json
{
  • "task_id": 0
}

Примеры ответа

Content type
application/json

Причины отмены отправления

post
/v1/posting/fbs/cancel-reason

Возвращает список причин отмены для конкретных отправлений.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
related_posting_numbers
required
Array of strings

Номера отправлений.

Ответы

Response Schema: application/json
Array of objects

Результат запроса.

Array ()
posting_number
string

Номер отправления.

Array of objects

Информация о причинах отмены.

Примеры запроса

Content type
application/json
{
  • "related_posting_numbers": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "reasons": [
        • {
          },
        • {
          },
        • {
          }
        ]
      }
    ]
}

Причины отмены отправлений

post
/v2/posting/fbs/cancel-reason/list

Возвращает список причин отмены для всех отправлений.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Ответы

Response Schema: application/json
Array of objects

Результат работы метода.

Array ()
id
integer <int64>

Идентификатор причины отмены.

is_available_for_cancellation
boolean

Результат отмены отправления. true, если запрос доступен для отмены.

title
string

Название категории.

type_id
string

Инициатор отмены отправления:

  • buyer — покупатель,
  • seller — продавец.

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
}

Отменить отправку некоторых товаров в отправлении

post
/v2/posting/fbs/product/cancel

Используйте метод, если вы не можете отправить часть продуктов из отправления.

Чтобы получить идентификаторы причин отмены cancel_reason_id при работе по схемам FBS или rFBS, используйте метод /v2/posting/fbs/cancel-reason/list.

Условно-доставленные отправления отменить нельзя.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
cancel_reason_id
required
integer <int64>

Идентификатор причины отмены отправления товара.

cancel_reason_message
required
string

Обязательное поле. Дополнительная информация по отмене.

required
Array of objects

Информация о товарах.

posting_number
required
string

Идентификатор отправления.

Ответы

Response Schema: application/json
result
string

Номер отправления.

Примеры запроса

Content type
application/json
{
  • "cancel_reason_id": 352,
  • "cancel_reason_message": "Product is out of stock",
  • "items": [
    • {
      }
    ],
  • "posting_number": "33920113-1231-1"
}

Примеры ответа

Content type
application/json
{
  • "result": ""
}

Отменить отправление

post
/v2/posting/fbs/cancel

Меняет статус отправления на cancelled.

Перед началом работы проверьте причины отмены для конкретного отправления методом /v1/posting/fbs/cancel-reason.

Условно-доставленные отправления отменить нельзя.

Если значение параметра cancel_reason_id — 402, заполните поле cancel_reason_message.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
cancel_reason_id
integer <int64>

Идентификатор причины отмены отправления.

cancel_reason_message
string

Дополнительная информация по отмене. Если cancel_reason_id = 402, параметр обязательный.

posting_number
string

Идентификатор отправления.

Ответы

Response Schema: application/json
result
boolean

Результат обработки запроса. true, если запрос выполнился без ошибок.

Примеры запроса

Content type
application/json
{
  • "cancel_reason_id": 352,
  • "cancel_reason_message": "Product is out of stock",
  • "posting_number": "33920113-1231-1"
}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Открыть спор по отправлению

post
/v2/posting/fbs/arbitration

Если отправление передано в доставку, но не просканировано в сортировочном центре, можно открыть спор. Открытый спор переведёт отправление в статус arbitration.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
Array of strings

Идентификатор отправления.

Ответы

Response Schema: application/json
result
boolean

Результат обработки запроса. true, если запрос выполнился без ошибок.

Примеры запроса

Content type
application/json
{
  • "posting_number": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Передать отправление к отгрузке

post
/v2/posting/fbs/awaiting-delivery

Передает спорные заказы к отгрузке. Статус отправления изменится на awaiting_deliver.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
Array of strings

Идентификатор отправления. Максимальное количество в одном запросе — 100.

Ответы

Response Schema: application/json
result
boolean

Результат обработки запроса. true, если запрос выполнился без ошибок.

Примеры запроса

Content type
application/json
{
  • "posting_number": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Проверить код курьера

post
/v1/posting/fbs/pick-up-code/verify

Метод позволяет проверить код курьера при передаче отправлений realFBS Express. Подробнее о передаче отправлений в Базе знаний продавца.

Request Body schema: application/json
pickup_code
required
string

Код курьера.

posting_number
required
string

Номер отправления.

Ответы

Response Schema: application/json
valid
boolean

true, если код корректный.

Примеры запроса

Content type
application/json
{
  • "pickup_code": "string",
  • "posting_number": "string"
}

Примеры ответа

Content type
application/json
{
  • "valid": true
}

Таможенные декларации ETGB

post
/v1/posting/global/etgb

Метод для получения таможенных деклараций Elektronik Ticaret Gümrük Beyannamesi (ETGB) для продавцов из Турции.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
required
object

Фильтр по периоду создания деклараций.

Ответы

Response Schema: application/json
Array of objects

Результат запроса.

Array ()
posting_number
string

Номер отправления.

object

Информация о декларации.

Примеры запроса

Content type
application/json
{
  • "date": {
    }
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "etgb": {
        }
      }
    ]
}

Список неоплаченных товаров, заказанных юридическими лицами

post
/v1/posting/unpaid-legal/product/list
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
cursor
string

Указатель для выборки следующих данных.

limit
integer <int32> [ 1 .. 1000 ]

Количество значений в ответе.

Ответы

Response Schema: application/json
Array of objects

Список неоплаченных товаров.

cursor
string

Указатель для выборки следующих данных.

Примеры запроса

Content type
application/json
{
  • "cursor": "hCGiPPopcBFMgMErdzaCEpzQfinuPyEhUoSmBMADuoFAhBjXeA==",
  • "limit": 1000
}

Примеры ответа

Content type
application/json
{
  • "products": [
    • {
      }
    ],
  • "cursor": "hCGiPPopcBFMgMErdzaCEpzQfinuPyEhUoSmBMADuoFAhBjXeA=="
}

Полигоны

Создайте полигон доставки

post
/v1/polygon/create

Вы можете добавить полигон к методу доставки.

Создайте полигон, получив его координаты на https://geojson.io: отметьте на карте минимум 3 точки и соедините их линиями.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
coordinates
required
string

Координаты полигона доставки в формате [[[lat long]]].

Ответы

Response Schema: application/json
polygon_id
integer <int64>

Идентификатор полигона.

Примеры запроса

Content type
application/json
{
  • "coordinates": "[[[30.149574279785153,59.86550435303646],[30.21205902099609,59.846884387977326],[30.255661010742184,59.86240174913176],[30.149574279785153,59.86550435303646]]]"
}

Примеры ответа

Content type
application/json
{
  • "polygonId": "1323"
}

Свяжите метод доставки с полигоном доставки

post
/v1/polygon/bind
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
delivery_method_id
required
integer <int32>

Идентификатор метода доставки.

required
Array of objects

Список полигонов.

required
object

Расположение склада.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "delivery_method_id": 0,
  • "polygons": [
    • {
      }
    ],
  • "warehouse_location": {
    }
}

Примеры ответа

Content type
application/json
{ }

Доставка FBO

Список отправлений

post
/v2/posting/fbo/list

Возвращает список отправлений за указанный период времени. Если период больше года, вернётся ошибка PERIOD_IS_TOO_LONG.

Дополнительно можно отфильтровать отправления по их статусу.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
dir
string

Направление сортировки:

  • asc — по возрастанию,
  • desc — по убыванию.
required
object

Фильтр для поиска отправлений.

limit
required
integer <int64>

Количество значений в ответе:

  • максимум — 1000,
  • минимум — 1.
offset
integer <int64>

Количество элементов, которое будет пропущено в ответе. Например, если offset = 10, то ответ начнётся с 11-го найденного элемента. Максимальное значение — 20000.

translit
boolean

Если включена транслитерация адреса из кириллицы в латиницу — true.

object

Дополнительные поля, которые нужно добавить в ответ.

Ответы

Response Schema: application/json
Array of objects

Массив отправлений.

Array ()
Array of objects
object

Данные аналитики.

cancel_reason_id
integer <int64>

Идентификатор причины отмены отправления.

created_at
string <date-time>

Дата и время создания отправления.

object

Финансовые данные.

in_process_at
string <date-time>

Дата и время начала обработки отправления.

order_id
integer <int64>

Идентификатор заказа, к которому относится отправление.

order_number
string

Номер заказа, к которому относится отправление.

posting_number
string

Номер отправления.

Array of objects

Список товаров в отправлении.

status
string

Статус отправления:

  • awaiting_packaging — ожидает упаковки,
  • awaiting_deliver — ожидает отгрузки,
  • delivering — доставляется,
  • delivered — доставлено,
  • cancelled — отменено.

Примеры запроса

Content type
application/json
{
  • "dir": "ASC",
  • "filter": {
    },
  • "limit": 5,
  • "offset": 0,
  • "translit": true,
  • "with": {
    }
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "products": [
        • {
          }
        ],
      • "analytics_data": {
        },
      • "financial_data": {
        • "products": [
          • {
            • "actions": [
              ],
            }
          ]
        },
      }
    ]
}

Информация об отправлении

post
/v2/posting/fbo/get

Возвращает информацию об отправлении по его идентификатору.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
string

Номер отправления.

translit
boolean

Если включена транслитерация адреса из кириллицы в латиницу — true.

object

Дополнительные поля, которые нужно добавить в ответ.

Ответы

Response Schema: application/json
object

Результат запроса.

Array of objects
object

Данные аналитики.

cancel_reason_id
integer <int64>

Идентификатор причины отмены отправления.

created_at
string <date-time>

Дата и время создания отправления.

object

Финансовые данные.

in_process_at
string <date-time>

Дата и время начала обработки отправления.

order_id
integer <int64>

Идентификатор заказа, к которому относится отправление.

order_number
string

Номер заказа, к которому относится отправление.

posting_number
string

Номер отправления.

Array of objects

Список товаров в отправлении.

status
string

Статус отправления:

  • awaiting_packaging — ожидает упаковки,
  • awaiting_deliver — ожидает отгрузки,
  • delivering — доставляется,
  • delivered — доставлено,
  • cancelled — отменено.

Примеры запроса

Content type
application/json
{
  • "posting_number": "50520644-0012-7",
  • "translit": true,
  • "with": {
    }
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "products": [
      • {
        }
      ],
    • "analytics_data": {
      },
    • "financial_data": {
      • "products": [
        • {
          • "actions": [
            ],
          }
        ]
      },
    }
}

Причины отмены отправлений по схеме FBO

post
/v1/posting/fbo/cancel-reason/list

Возвращает список причин отмены для всех FBO-отправлений.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Ответы

Response Schema: application/json
Array of objects

Результат работы метода.

Array ()
id
integer <int64>

Идентификатор причины отмены.

is_available_for_cancellation
boolean

Результат отмены отправления. true, если запрос доступен для отмены.

title
string

Название категории.

type_id
string

Инициатор отмены отправления:

  • buyer — покупатель,
  • seller — продавец.

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
}

Количество заявок по статусам

post
/v1/supply-order/status/counter

Возвращает количество заявок в конкретном статусе.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Ответы

Response Schema: application/json
Array of objects
Array ()
count
integer <int32>

Количество заявок в статусе.

order_state
string
Default: "ORDER_STATE_UNSPECIFIED"
Enum: "ORDER_STATE_UNSPECIFIED" "ORDER_STATE_DATA_FILLING" "ORDER_STATE_READY_TO_SUPPLY" "ORDER_STATE_ACCEPTED_AT_SUPPLY_WAREHOUSE" "ORDER_STATE_IN_TRANSIT" "ORDER_STATE_ACCEPTANCE_AT_STORAGE_WAREHOUSE" "ORDER_STATE_REPORTS_CONFIRMATION_AWAITING" "ORDER_STATE_REPORT_REJECTED" "ORDER_STATE_COMPLETED" "ORDER_STATE_REJECTED_AT_SUPPLY_WAREHOUSE" "ORDER_STATE_CANCELLED"

Статус поставки:

  • UNSPECIFIED — статус не указан;
  • DATA_FILLING — заполнение данных;
  • READY_TO_SUPPLY — готова к отгрузке;
  • ACCEPTED_AT_SUPPLY_WAREHOUSE — принята на точке отгрузки;
  • IN_TRANSIT — в пути;
  • ACCEPTANCE_AT_STORAGE_WAREHOUSE — приёмка на складе;
  • REPORTS_CONFIRMATION_AWAITING — согласование актов;
  • REPORT_REJECTED — спор;
  • COMPLETED — завершена;
  • REJECTED_AT_SUPPLY_WAREHOUSE — отказано в приёмке;
  • CANCELLED — отменена.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
application/json
{
  • "items": [
    • {
      }
    ]
}

Состав поставки или заявки на поставку

post
/v1/supply-order/bundle

Используйте метод, чтобы получить товарный состав поставки или черновика заявки на поставку. Одним вызовом метода можно получить состав одной поставки или черновика заявки.

Request Body schema: application/json
bundle_ids
required
Array of strings [ 1 .. 100 ] items

Идентификаторы товарного состава поставки. Можно получить в методе /v2/supply-order/get.

is_asc
boolean

true, чтобы сортировать по возрастанию.

object

Список складов для расчёта товарных тегов.

last_id
string

Идентификатор последнего значения SKU на странице.

limit
required
integer <int32> [ 1 .. 100 ]

Количество товаров на странице.

query
string

Поисковый запрос, например: по названию, артикулу или SKU.

sort_field
string
Default: "UNSPECIFIED"
Enum: "UNSPECIFIED" "SKU" "NAME" "QUANTITY" "TOTAL_VOLUME_IN_LITRES"

Сортировка по параметрам:

  • SKU — SKU;
  • NAME — названию товара;
  • QUANTITY — количеству;
  • TOTAL_VOLUME_IN_LITRES — объёму в литрах.

Ответы

Response Schema: application/json
Array of objects

Список товаров в заявке на поставку.

total_count
integer <int32>

Количество товаров в заявке.

has_next
boolean

Признак, что в ответе вернули не все товары:

  • true — сделайте повторный запрос с другим значением page и page_size, чтобы получить информацию об остальных товарах;
  • false — ответ содержит все товары из заявки.
last_id
string

Идентификатор последнего значения на странице.

Примеры запроса

Content type
application/json
{
  • "bundle_ids": [
    ],
  • "is_asc": true,
  • "item_tags_calculation": {
    • "storage_warehouse_ids": [
      ]
    },
  • "limit": 0,
  • "query": "",
  • "sort_field": "UNSPECIFIED"
}

Примеры ответа

Content type
application/json
{
  • "items": [
    • {
      • "tags": [
        ]
      }
    ],
  • "total_count": 0,
  • "has_next": true,
  • "last_id": "string"
}

Список заявок на поставку на склад Ozon

post
/v2/supply-order/list

Учитываются заявки с поставкой на конкретный склад и через виртуальный распределительный центр (вРЦ).

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Фильтр.

required
object

Настройка отображения списка заявок.

Ответы

Response Schema: application/json
last_supply_order_id
integer <int64>

Идентификатор заявки на поставку, который вы запрашивали в прошлый раз.

supply_order_id
Array of strings <int64>

Идентификатор заявки на поставку.

Примеры запроса

Content type
application/json
{
  • "filter": {
    • "states": [
      ]
    },
  • "paging": {
    }
}

Примеры ответа

Content type
application/json
{
  • "last_supply_order_id": 0,
  • "supply_order_id": [
    ]
}

Информация о заявке на поставку

post
/v2/supply-order/get

Учитываются заявки с поставкой на конкретный склад и через виртуальный распределительный центр (вРЦ).

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
order_ids
required
Array of strings <int64>

Идентификатор заявки на поставку в системе Ozon.

Ответы

Response Schema: application/json
Array of objects

Информация о заявке на поставку.

Array of objects

Информация о складе.

Примеры запроса

Content type
application/json
{
  • "order_ids": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "orders": [
    • {
      • "supplies": [
        • {
          • "supply_tags": [
            • {
              }
            ]
          }
        ],
      • "timeslot": {
        • "can_not_set_reasons": [
          ],
        • "value": {
          • "timeslot": [
            • {
              }
            ],
          • "timezone_info": [
            • {
              }
            ]
          }
        },
      • "vehicle": {
        • "can_not_set_reasons": [
          ],
        • "value": [
          • {
            }
          ]
        }
      }
    ],
  • "warehouses": [
    • {
      }
    ]
}

Интервалы поставки

post
/v1/supply-order/timeslot/get
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
supply_order_id
required
integer <int64>

Идентификатор заявки на поставку.

Ответы

Response Schema: application/json
Array of objects

Интервалы поставки.

Array of objects

Часовой пояс.

Примеры запроса

Content type
application/json
{
  • "supply_order_id": 0
}

Примеры ответа

Content type
application/json
{
  • "timeslots": [
    • {
      }
    ],
  • "timezone": [
    • {
      }
    ]
}

Обновить интервал поставки

post
/v1/supply-order/timeslot/update
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
supply_order_id
required
integer <int64>

Идентификатор заявки на поставку.

required
object

Время интервала поставки.

Ответы

Response Schema: application/json
errors
Array of strings
Items Enum: "UPDATE_TIMESLOT_ERROR_UNSPECIFIED" "UPDATE_TIMESLOT_ERROR_INVALID_ORDER_STATE" "UPDATE_TIMESLOT_ERROR_INCOMPATIBLE_ORDER_FLOW" "UPDATE_TIMESLOT_ERROR_SET_TIMESLOT_DEADLINE_EXCEED" "UPDATE_TIMESLOT_ERROR_OUT_OF_ALLOWED_RANGE" "UPDATE_TIMESLOT_ERROR_ORDER_NOT_BELONG_CONTRACTOR" "UPDATE_TIMESLOT_ERROR_ORDER_NOT_BELONG_COMPANY"

Возможные ошибки:

  • UNSPECIFIED — статус не указан;
  • INVALID_ORDER_STATE — неверный статус заказа;
  • INCOMPATIBLE_ORDER_FLOW — неверный статус интервала поставки;
  • SET_TIMESLOT_DEADLINE_EXCEED — заявка на поставку просрочена;
  • OUT_OF_ALLOWED_RANGE — вы ввели некорректное значение интервала поставки;
  • ORDER_NOT_BELONG_CONTRACTOR — заявка создана другим юридическим лицом, работать с ней не получится;
  • ORDER_NOT_BELONG_COMPANY — заявка не принадлежит вашему кабинету, работать с ней не получится.
operation_id
string

Идентификатор операции.

Примеры запроса

Content type
application/json
{
  • "supply_order_id": 0,
  • "timeslot": {
    }
}

Примеры ответа

Content type
application/json
{
  • "errors": [
    ],
  • "operation_id": "string"
}

Статус интервала поставки

post
/v1/supply-order/timeslot/status
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
operation_id
required
string

Идентификатор операции.

Ответы

Response Schema: application/json
errors
Array of strings
Items Enum: "UPDATE_TIMESLOT_ERROR_UNSPECIFIED" "UPDATE_TIMESLOT_ERROR_INVALID_ORDER_STATE" "UPDATE_TIMESLOT_ERROR_INCOMPATIBLE_ORDER_FLOW" "UPDATE_TIMESLOT_ERROR_SET_TIMESLOT_DEADLINE_EXCEED" "UPDATE_TIMESLOT_ERROR_OUT_OF_ALLOWED_RANGE" "UPDATE_TIMESLOT_ERROR_ORDER_NOT_BELONG_CONTRACTOR" "UPDATE_TIMESLOT_ERROR_ORDER_NOT_BELONG_COMPANY"

Возможные ошибки:

  • UNSPECIFIED — статус не указан;
  • INVALID_ORDER_STATE — неверный статус заказа;
  • INCOMPATIBLE_ORDER_FLOW — неверный статус интервала поставки;
  • SET_TIMESLOT_DEADLINE_EXCEED — заявка на поставку просрочена;
  • OUT_OF_ALLOWED_RANGE — вы ввели некорректное значение интервала поставки;
  • ORDER_NOT_BELONG_CONTRACTOR — заявка создана другим юридическом лицом, работать с ней не получится;
  • ORDER_NOT_BELONG_COMPANY — заявка не принадлежит вашему кабинету, работать с ней не получится.
status
string
Default: "STATUS_UNSPECIFIED"
Enum: "STATUS_UNSPECIFIED" "STATUS_ERROR" "STATUS_IN_PROGRESS" "STATUS_SUCCESS"

Статус данных:

  • UNSPECIFIED — не указан;
  • ERROR — ошибка;
  • IN_PROGRESS — устанавливается;
  • SUCCESS — установлен.

Примеры запроса

Content type
application/json
{
  • "operation_id": "string"
}

Примеры ответа

Content type
application/json
{
  • "errors": [
    ],
  • "status": "STATUS_UNSPECIFIED"
}

Указать данные о водителе и автомобиле

post
/v1/supply-order/pass/create
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
supply_order_id
required
integer <int64>

Идентификатор заявки на поставку.

required
object

Информация о водителе и автомобиле.

Ответы

Response Schema: application/json
error_reasons
Array of strings
Items Enum: "SET_VEHICLE_ERROR_UNSPECIFIED" "SET_VEHICLE_ERROR_INVALID_ORDER_STATE" "SET_VEHICLE_ERROR_VEHICLE_NOT_REQUIRED" "SET_VEHICLE_ERROR_ORDER_NOT_BELONG_CONTRACTOR" "SET_VEHICLE_ERROR_ORDER_NOT_BELONG_COMPANY"

Причина ошибки:

  • UNSPECIFIED — статус заявки не указан;
  • INVALID_ORDER_STATE — неверный статус заявки;
  • VEHICLE_NOT_REQUIRED — указывать данные автомобиля необязательно;
  • ORDER_NOT_BELONG_CONTRACTOR — заявка создана другим юридическом лицом, работать с ней не получится;
  • ORDER_NOT_BELONG_COMPANY — заявка не принадлежит вашему кабинету, работать с ней не получится.
operation_id
string

Идентификатор операции.

Примеры запроса

Content type
application/json
{
  • "supply_order_id": 0,
  • "vehicle": {
    }
}

Примеры ответа

Content type
application/json
{
  • "error_reasons": [
    ],
  • "operation_id": "string"
}

Статус ввода данных о водителе и автомобиле

post
/v1/supply-order/pass/status
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
operation_id
required
string

Идентификатор операции.

Ответы

Response Schema: application/json
errors
Array of strings
Items Enum: "SET_VEHICLE_ERROR_UNSPECIFIED" "SET_VEHICLE_ERROR_INVALID_ORDER_STATE" "SET_VEHICLE_ERROR_VEHICLE_NOT_REQUIRED" "SET_VEHICLE_ERROR_ORDER_NOT_BELONG_CONTRACTOR" "SET_VEHICLE_ERROR_ORDER_NOT_BELONG_COMPANY"

Причина ошибки:

  • UNSPECIFIED — статус не указан;
  • INVALID_ORDER_STATE — неверный статус заявки;
  • VEHICLE_NOT_REQUIRED — указывать данные автомобиля необязательно;
  • ORDER_NOT_BELONG_CONTRACTOR — заявка создана другим юридическом лицом, работать с ней не получится;
  • ORDER_NOT_BELONG_COMPANY — заявка не принадлежит вашему кабинету, работать с ней не получится.
result
string
Default: "Unknown"
Enum: "Unknown" "Success" "InProgress" "Failed"

Статус ввода данных о водителе и автомобиле:

  • Unknown — статус неизвестен;
  • Success — данные указаны;
  • InProgress — данные обрабатываются;
  • Failed — не удалось обработать данные.

Примеры запроса

Content type
application/json
{
  • "operation_id": "string"
}

Примеры ответа

Content type
application/json
{
  • "errors": [
    ],
  • "result": "Unknown"
}

Загруженность складов Ozon

get
/v1/supplier/available_warehouses

Метод возвращает список активных складов Ozon с информацией об их средней загруженности на ближайшее время.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Ответы

Response Schema: application/json
Array of objects

Результат работы метода.

Array ()
object

Загруженность.

object

Склад.

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "schedule": {
        • "capacity": [
          • {
            }
          ],
        },
      • "warehouse": {
        }
      }
    ]
}

Создание и управление заявками на поставку FBO

Информация о кластерах и их складах

post
/v1/cluster/list
Request Body schema: application/json
cluster_ids
Array of strings <int64>

Идентификаторы кластеров.

cluster_type
required
string
Enum: "CLUSTER_TYPE_OZON" "CLUSTER_TYPE_CIS"

Тип кластера:

  • CLUSTER_TYPE_OZON — кластер в России,
  • CLUSTER_TYPE_CIS — кластер в СНГ.

Ответы

Response Schema: application/json
Array of objects

Кластеры.

Array ()
id
integer <int64>

Идентификатор кластера.

Array of objects

Информация о складах кластера.

name
string

Название кластера.

type
string
Enum: "CLUSTER_TYPE_OZON" "CLUSTER_TYPE_CIS"

Тип кластера:

  • CLUSTER_TYPE_OZON — кластер в России,
  • CLUSTER_TYPE_CIS — кластер в СНГ.

Примеры запроса

Content type
application/json
{
  • "cluster_ids": [
    ],
  • "cluster_type": "CLUSTER_TYPE_OZON"
}

Примеры ответа

Content type
application/json
{
  • "clusters": [
    • {
      • "logistic_clusters": [
        • {
          • "warehouses": [
            • {
              }
            ]
          }
        ],
      }
    ]
}

Поиск точек для отгрузки поставки

post
/v1/warehouse/fbo/list

Используйте метод, чтобы найти сортировочное центры, пункты выдачи или приёма заказов, доступные для кросс-докинга и прямых поставок.

Вы можете посмотреть адреса всех точек на карте и в виде таблицы в Базе знаний.

Request Body schema: application/json
filter_by_supply_type
required
Array of strings
Items Enum: "CREATE_TYPE_CROSSDOCK" "CREATE_TYPE_DIRECT"

Тип поставки:

  • CREATE_TYPE_CROSSDOCK — кросс-докинг,
  • CREATE_TYPE_DIRECT — прямая.
search
required
string >= 4 characters

Поиск по названию склада. Для поиска пунктов выдачи заказов укажите полное название.

Ответы

Response Schema: application/json
Array of objects

Результат поиска складов.

Array ()
address
string

Адрес склада.

object

Координаты склада.

name
string

Название склада.

warehouse_id
integer <int64>

Идентификатор склада, пункта выдачи заказов или сортировочного центра.

warehouse_type
string
Enum: "WAREHOUSE_TYPE_DELIVERY_POINT" "WAREHOUSE_TYPE_ORDERS_RECEIVING_POINT" "WAREHOUSE_TYPE_SORTING_CENTER" "WAREHOUSE_TYPE_FULL_FILLMENT" "WAREHOUSE_TYPE_CROSS_DOCK"

Тип склада, пункта выдачи заказов или сортировочного центра:

  • WAREHOUSE_TYPE_DELIVERY_POINT — пункт выдачи заказов,
  • WAREHOUSE_TYPE_ORDERS_RECEIVING_POINT — пункт приёма заказов,
  • WAREHOUSE_TYPE_SORTING_CENTER — сортировочный центр,
  • WAREHOUSE_TYPE_FULL_FILLMENT — фулфилмент,
  • WAREHOUSE_TYPE_CROSS_DOCK — кросс-докинг.

Примеры запроса

Content type
application/json
{
  • "filter_by_supply_type": [
    ],
  • "search": "string"
}

Примеры ответа

Content type
application/json
{
  • "search": [
    • {
      • "coordinates": {
        },
      }
    ]
}

Создать черновик заявки на поставку

post
/v1/draft/create

Создать черновик заявки на поставку — прямой или кросс-докинг, а также указать поставляемые товары.

Request Body schema: application/json
cluster_ids
Array of strings <int64>

Идентификаторы кластеров.

drop_off_point_warehouse_id
integer <int64>

Идентификатор точки отгрузки — пункта выдачи заказов или сортировочного центра. Только для типа поставки type = CREATE_TYPE_CROSSDOCK.

required
Array of objects <= 5000 items

Товары.

type
required
string
Enum: "CREATE_TYPE_CROSSDOCK" "CREATE_TYPE_DIRECT"

Тип поставки:

  • CREATE_TYPE_CROSSDOCK — кросс-докинг,
  • CREATE_TYPE_DIRECT — прямая.

Ответы

Response Schema: application/json
operation_id
string

Идентификатор черновика заявки на поставку.

Примеры запроса

Content type
application/json
{
  • "cluster_ids": [
    ],
  • "drop_off_point_warehouse_id": 0,
  • "items": [
    • {
      }
    ],
  • "type": "CREATE_TYPE_CROSSDOCK"
}

Примеры ответа

Content type
application/json
{
  • "operation_id": "string"
}

Информация о черновике заявки на поставку

post
/v1/draft/create/info
Request Body schema: application/json
operation_id
required
string

Идентификатор черновика заявки на поставку.

Ответы

Response Schema: application/json
Array of objects

Кластеры.

draft_id
integer <int64>

Идентификатор черновика заявки на поставку.

Array of objects

Ошибки.

status
string
Default: "CALCULATION_STATUS_FAILED"
Enum: "CALCULATION_STATUS_FAILED" "CALCULATION_STATUS_SUCCESS" "CALCULATION_STATUS_IN_PROGRESS" "CALCULATION_STATUS_EXPIRED"

Статус создания черновика заявки на поставку:

  • CALCULATION_STATUS_FAILED — не удалось создать черновик,
  • CALCULATION_STATUS_SUCCESS — черновик создан,
  • CALCULATION_STATUS_IN_PROGRESS — черновик создаётся,
  • CALCULATION_STATUS_EXPIRED — истёк срок действия черновика.

Примеры запроса

Content type
application/json
{
  • "operation_id": "string"
}

Примеры ответа

Content type
application/json
{
  • "clusters": [
    • {
      • "warehouses": [
        • {
          • "bundle_ids": [
            • {
              }
            ],
          • "status": {
            },
          • "supply_warehouse": {
            },
          }
        ]
      }
    ],
  • "draft_id": 0,
  • "errors": [
    • {
      • "items_validation": [
        • {
          • "reasons": [
            ],
          }
        ],
      • "unknown_cluster_ids": [
        ]
      }
    ],
  • "status": "CALCULATION_STATUS_FAILED"
}

Доступные таймслоты

post
/v1/draft/timeslot/info

Доступные таймслоты на конечных складах отгрузки.

Request Body schema: application/json
date_from
required
string <date-time>

Дата начала нужного периода доступных таймслотов.

date_to
required
string <date-time>

Дата окончания нужного периода доступных таймслотов.

Максимальный период — 28 дней с текущей даты.

draft_id
required
integer <int64>

Идентификатор черновика заявки на поставку.

warehouse_ids
required
Array of strings <int64> <= 10 items

Идентификаторы складов, для которых нужно получить таймслоты.

Ответы

Response Schema: application/json
Array of objects

Таймслоты складов.

requested_date_from
string <date-time>

Дата начала интересующего периода.

requested_date_to
string <date-time>

Дата окончания интересующего периода.

Примеры запроса

Content type
application/json
{
  • "date_from": "2019-08-24T14:15:22Z",
  • "date_to": "2019-08-24T14:15:22Z",
  • "draft_id": 0,
  • "warehouse_ids": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "drop_off_warehouse_timeslots": [
    • {
      • "days": [
        • {
          • "timeslots": [
            • {
              }
            ]
          }
        ],
      }
    ],
  • "requested_date_from": "2019-08-24T14:15:22Z",
  • "requested_date_to": "2019-08-24T14:15:22Z"
}

Создать заявку на поставку по черновику

post
/v1/draft/supply/create
Request Body schema: application/json
draft_id
required
integer <int64>

Идентификатор черновика заявки на поставку.

object

Таймслот поставки.

warehouse_id
required
integer <int64>

Идентификатор склада отгрузки.

Ответы

Response Schema: application/json
operation_id
string

Идентификатор заявки на поставку.

Примеры запроса

Content type
application/json
{
  • "draft_id": 0,
  • "timeslot": {
    },
  • "warehouse_id": 0
}

Примеры ответа

Content type
application/json
{
  • "operation_id": "string"
}

Информация о создании заявки на поставку

post
/v1/draft/supply/create/status
Request Body schema: application/json
operation_id
required
string

Идентификатор заявки на поставку.

Ответы

Response Schema: application/json
error_messages
Array of strings

Ошибки создания заявок.

object

Идентификаторы заявок на поставку.

order_ids
Array of strings <int64>

Идентификаторы заявок на поставку.

status
string
Default: "DraftSupplyCreateStatusUnknown"
Enum: "DraftSupplyCreateStatusUnknown" "DraftSupplyCreateStatusSuccess" "DraftSupplyCreateStatusFailed" "DraftSupplyCreateStatusInProgress"

Статус создания заявки на поставку:

  • DraftSupplyCreateStatusUnknown — неизвестный,
  • DraftSupplyCreateStatusSuccess — создана,
  • DraftSupplyCreateStatusFailed — не создана,
  • DraftSupplyCreateStatusInProgress — создаётся.

Примеры запроса

Content type
application/json
{
  • "operation_id": "string"
}

Примеры ответа

Content type
application/json
{
  • "error_messages": [
    ],
  • "result": {
    • "order_ids": [
      ]
    },
  • "status": "DraftSupplyCreateStatusUnknown"
}

Установка грузомест

post
/v1/cargoes/create

Используйте метод, чтобы передать грузоместа и товарный состав в заявку на поставку.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
required
Array of objects

Информация о грузоместах. Вы можете передать не больше 40 палет или 30 коробок.

delete_current_version
boolean

true, если нужно удалить предыдущие грузоместа.

supply_id
required
integer <int64>

Идентификатор поставки.

Ответы

Response Schema: application/json
operation_id
string

Идентификатор операции.

object

Ошибки.

Примеры запроса

Content type
application/json
{
  • "cargoes": [
    • {
      • "value": {
        • "items": [
          • {
            }
          ],
        }
      }
    ],
  • "delete_current_version": true,
  • "supply_id": 0
}

Примеры ответа

Content type
application/json
{
  • "operation_id": "string",
  • "errors": {
    • "error_reasons": [
      ],
    • "items_validation": [
      • {
        }
      ]
    }
}

Получить информацию по установке грузомест

post
/v1/cargoes/create/info

Используйте метод, чтобы получить информацию по установленным грузоместам.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
operation_id
required
string

Идентификатор операции.

Ответы

Response Schema: application/json
object

Результат запроса.

Array of objects

Информация о грузоместах.

status
string
Default: "SUCCESS"
Enum: "SUCCESS" "IN_PROGRESS" "FAILED"

Статус формирования грузомест:

  • SUCCESS — успешно.
  • IN_PROGRESS — формируются.
  • FAILED — при формировании грузомест произошла ошибка.
object

Ошибки.

Примеры запроса

Content type
application/json
{
  • "operation_id": "string"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "cargoes": [
      • {
        • "value": {
          }
        }
      ]
    },
  • "status": "SUCCESS",
  • "errors": {
    • "error_reasons": [
      ],
    • "items_validation": [
      • {
        }
      ]
    }
}

Сгенерировать этикетки для грузомест

post
/v1/cargoes-label/create

Используйте метод, чтобы сгенерировать этикетки для грузомест из заявки на поставку.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
Array of objects

Информация о грузоместах.

supply_id
required
integer <int64>

Идентификатор поставки.

Ответы

Response Schema: application/json
operation_id
string

Идентификатор операции.

object

Ошибки.

Примеры запроса

Content type
application/json
{
  • "cargoes": [
    • {
      }
    ],
  • "supply_id": 0
}

Примеры ответа

Content type
application/json
{
  • "operation_id": "string",
  • "errors": {
    • "error_reasons": [
      ]
    }
}

Получить идентификатор этикетки для грузомест

post
/v1/cargoes-label/get

Используйте метод, чтобы получить статус формирования этикеток и идентификатор файла с ними.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
operation_id
required
string

Идентификатор операции.

Ответы

Response Schema: application/json
object

Информация об этикетках.

file_guid
string

Идентификатор для получения файла с этикетками.

status
string
Default: "SUCCESS"
Enum: "SUCCESS" "IN_PROGRESS" "FAILED"

Статус формирования этикеток:

  • SUCCESS — готовы.
  • IN_PROGRESS — формируются.
  • FAILED — ошибка при формировании.
object

Ошибки.

Примеры запроса

Content type
application/json
{
  • "operation_id": "string"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    },
  • "status": "SUCCESS",
  • "errors": {
    • "error_reasons": [
      ]
    }
}

Получить PDF с этикетками грузовых мест

get
/v1/cargoes-label/file/{file_guid}
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Ответы

Примеры ответа

Content type
application/json
{
  • "code": 0,
  • "details": [
    • {
      }
    ],
  • "message": "string"
}

Отменить заявку на поставку

post
/v1/supply-order/cancel
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
order_id
required
integer <int64>

Идентификатор заявки на поставку.

Ответы

Response Schema: application/json
operation_id
string

Идентификатор операции на отмену заявки.

Примеры запроса

Content type
application/json
{
  • "order_id": 0
}

Примеры ответа

Content type
application/json
{
  • "operation_id": "string"
}

Получить статус отмены заявки на поставку

post
/v1/supply-order/cancel/status
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
operation_id
required
string

Идентификатор операции на отмену заявки на поставку.

Ответы

Response Schema: application/json
error_reasons
Array of strings
Items Enum: "INVALID_ORDER_STATE" "ORDER_IS_VIRTUAL" "ORDER_DOES_NOT_BELONG_TO_CONTRACTOR" "ORDER_DOES_NOT_BELONG_TO_COMPANY" "OTHER_ASYNCHRONOUS_OPERATION_IN_PROGRESS"

Причина, по которой не удалось отменить заявку на поставку:

  • INVALID_ORDER_STATE — неверный статус заявки на поставку.
  • ORDER_IS_VIRTUAL — заявка виртуальная.
  • ORDER_DOES_NOT_BELONG_TO_CONTRACTOR — заявка на поставку не принадлежит вашему юридическому лицу.
  • ORDER_DOES_NOT_BELONG_TO_COMPANY — заявка на поставку не принадлежит продавцу.
  • OTHER_ASYNCHRONOUS_OPERATION_IN_PROGRESS — заявка на поставку в процессе отмены.
object

Информация об отмене заявки на поставку.

is_order_cancelled
boolean

true, если заявка на поставку отменена.

Array of objects

Список отменённых поставок.

status
string
Enum: "SUCCESS" "IN_PROGRESS" "ERROR"

Статус отмены заявки на поставку. Возможные значения:

  • SUCCESS — заявка отменена.
  • IN_PROGRESS — заявки в процессе отмены.
  • ERROR — ошибка.

Примеры запроса

Content type
application/json
{
  • "operation_id": "string"
}

Примеры ответа

Content type
application/json
{
  • "error_reasons": [
    ],
  • "result": {
    • "supplies": [
      • {
        • "error_reasons": [
          ],
        }
      ]
    },
  • "status": "SUCCESS"
}

Управление кодами маркировки и сборкой заказов для FBS/rFBS

Получить данные созданных экземпляров

post
/v6/fbs/posting/product/exemplar/create-or-get

Метод для получения информации по экземплярам товаров из отправления, переданных в методе /v6/fbs/posting/product/exemplar/set.

Используйте метод для получения exemplar_id.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
string

Номер отправления.

Ответы

Response Schema: application/json
multi_box_qty
integer <int32>

Количество коробок, в которые упакован товар.

posting_number
string

Номер отправления.

Array of objects

Список товаров.

Примеры запроса

Content type
application/json
{
  • "posting_number": "string"
}

Примеры ответа

Content type
application/json
{
  • "multi_box_qty": 0,
  • "posting_number": "string",
  • "products": [
    • {
      • "exemplars": [
        • {
          • "marks": [
            • {
              }
            ],
          }
        ],
      }
    ]
}

Получить информацию об экземплярах

post
/v5/fbs/posting/product/exemplar/create-or-get

Метод для получения информации по экземплярам товаров из отправления. Используйте метод для получения exemplar_id.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
string

Номер отправления.

Ответы

Response Schema: application/json
multi_box_qty
integer <int32>

Количество коробок, в которые упакован товар.

posting_number
string

Номер отправления.

Array of objects

Список товаров.

Примеры запроса

Content type
application/json
{
  • "posting_number": "string"
}

Примеры ответа

Content type
application/json
{
  • "multi_box_qty": 0,
  • "posting_number": "string",
  • "products": [
    • {
      • "exemplars": [
        • {
          }
        ],
      }
    ]
}

Валидация кодов маркировки

post
/v5/fbs/posting/product/exemplar/validate

Метод для проверки кодов на соответствие требованиям системы «Честный ЗНАК» по количеству и составу символов.

Если у вас нет номера грузовой таможенной декларации (ГТД), вы можете его не указывать.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
string

Номер отправления.

Array of objects

Список товаров.

Ответы

Response Schema: application/json
Array of objects

Список товаров.

Array ()
error
string

Код ошибки.

Array of objects

Информация об экземплярах.

product_id
integer <int64>

Идентификатор товара в системе Ozon — SKU.

valid
boolean

Результат прохождения проверки. true, если коды всех экземпляров соответствуют требованиям.

Примеры запроса

Content type
application/json
{
  • "posting_number": "string",
  • "products": [
    • {
      • "exemplars": [
        • {
          • "marks": [
            • {
              }
            ],
          }
        ],
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "products": [
    • {
      • "exemplars": [
        • {
          • "errors": [
            ],
          • "marks": [
            • {
              • "errors": [
                ],
              }
            ],
          }
        ],
      }
    ]
}

Валидация кодов маркировки

post
/v4/fbs/posting/product/exemplar/validate

Метод для проверки кодов на соответствие требованиям по количеству и составу символов.
Подробнее об ошибках в Базе знаний продавца

Если у вас нет номера грузовой таможенной декларации (ГТД), вы можете его не указывать.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
string

Номер отправления.

Array of objects

Список товаров.

Ответы

Response Schema: application/json
object

Результат работы метода.

Array of objects

Список товаров.

Примеры запроса

Content type
application/json
{
  • "posting_number": "23281294-0063-2",
  • "products": [
    • {
      • "exemplars": [
        • {
          }
        ],
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "products": [
      • {
        • "exemplars": [
          • {
            }
          ],
        }
      ]
    }
}

Проверить и сохранить данные экземпляров

post
/v6/fbs/posting/product/exemplar/set

Асинхронный метод:

  • для проверки наличия экземпляров в обороте в системе «Честный ЗНАК»;
  • для сохранения данных экземпляров.

Чтобы получить результаты проверок, используйте метод /v5/fbs/posting/product/exemplar/status. Для получения данных о созданных экземплярах, используйте метод /v6/fbs/posting/product/exemplar/create-or-get.

Если у вас несколько одинаковых товаров в отправлении, укажите один product_id и массив exemplars для каждого товара из отправления.

Всегда передавайте полный набор данных по экземплярам и продуктам.

Например, в вашей системе 10 экземпляров. Вы передали их для проверки и сохранения. Потом добавили в своей системе ещё 60 экземпляров. При повторной передаче экземпляров для проверки и сохранения укажите все экземпляры: и старые, и только что добавленные.

Код ответа 200 не гарантирует, что данные об экземплярах приняты. Он указывает, что создана задача для добавления информации. Чтобы проверить статус задачи, используйте метод /v5/fbs/posting/product/exemplar/status.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
multi_box_qty
integer <int32>

Количество коробок, в которые упакован товар.

posting_number
string

Номер отправления.

Array of objects

Список товаров.

Ответы

Примеры запроса

Content type
application/json
{
  • "multi_box_qty": 0,
  • "posting_number": "string",
  • "products": [
    • {
      • "exemplars": [
        • {
          • "marks": [
            • {
              }
            ],
          }
        ],
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "code": 0,
  • "details": [
    • {
      }
    ],
  • "message": "string"
}

Проверить и сохранить данные экземпляров (версия 5)

post
/v5/fbs/posting/product/exemplar/set

Асинхронный метод:

  • для проверки наличия экземпляров в обороте в системе «Честный ЗНАК»;
  • для сохранения данных экземпляров.

Используйте метод только для отправлений в статусе awaiting_packaging, иначе вы получите ошибку INVALID_POSTING_STATE.

Чтобы получить результаты проверок, используйте метод /v4/fbs/posting/product/exemplar/status. Для получения данных о созданных экземплярах, используйте метод /v5/fbs/posting/product/exemplar/create-or-get.

При необходимости укажите номер грузовой таможенной декларации в параметре gtd. Если его нет, передайте значение is_gtd_absent = true.

Если у вас несколько одинаковых товаров в отправлении, укажите один product_id и массив exemplars для каждого товара из отправления.

Всегда передавайте полный набор данных по экземплярам и продуктам.

Например, в вашей системе 10 экземпляров. Вы передали их для проверки и сохранения. Потом добавили в своей системе ещё 60 экземпляров. При повторной передаче экземпляров для проверки и сохранения укажите все экземпляры: и старые, и только что добавленные.

Отличие от /v4/fbs/posting/product/exemplar/set — вы можете передать в запросе больше информации по экземплярам.

Код ответа 200 не гарантирует, что данные об экземплярах приняты. Он указывает, что создана задача для добавления информации. Чтобы проверить статус задачи, используйте метод /v4/fbs/posting/product/exemplar/status.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
multi_box_qty
integer <int32>

Количество коробок, в которые упакован товар.

posting_number
required
string

Номер отправления.

required
Array of objects

Список товаров.

Ответы

Response Schema: application/json
result
boolean

Результат обработки запроса. true, если запрос обработан успешно.

Примеры запроса

Content type
application/json
{
  • "multi_box_qty": 0,
  • "posting_number": "string",
  • "products": [
    • {
      • "exemplars": [
        • {
          }
        ],
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Проверить и сохранить данные экземпляров

post
/v4/fbs/posting/product/exemplar/set

Асинхронный метод:

  • для проверки наличия экземпляров в обороте в системе «Честный ЗНАК»;
  • для сохранения данных экземпляров.

Чтобы получить результаты проверок, используйте метод /v4/fbs/posting/product/exemplar/status.

При необходимости укажите номер грузовой таможенной декларации в параметре gtd. Если его нет, передайте значение is_gtd_absent = true.

Если у вас несколько одинаковых товаров в отправлении, укажите один product_id и массив exemplars для каждого товара из отправления.

Всегда передавайте полный набор данных по экземплярам и продуктам.

Например, в вашей системе 10 экземпляров. Вы передали их для проверки и сохранения. Потом добавили в своей системе ещё 60 экземпляров. При повторной передаче экземпляров для проверки и сохранения укажите все экземпляры: и старые, и только что добавленные.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
string

Номер отправления.

Array of objects

Список товаров.

Ответы

Response Schema: application/json
result
boolean

Результат обработки запроса. true, если запрос обработан успешно.

Примеры запроса

Content type
application/json
{
  • "posting_number": "23281294-0063-2",
  • "products": [
    • {
      • "exemplars": [
        • {
          }
        ],
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Получить статус добавления экземпляров

post
/v5/fbs/posting/product/exemplar/status

Метод для получения статусов добавления экземпляров, переданных в методе /v6/fbs/posting/product/exemplar/set. Также возвращает данные по этим экземплярам.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
string

Номер отправления.

Ответы

Response Schema: application/json
posting_number
string

Номер отправления.

Array of objects

Список товаров.

status
string

Статус проверки всех экземпляров и доступности сборки:

  • ship_available — сборка доступна,
  • ship_not_available — сборка недоступна,
  • validation_in_process — экземпляры на проверке.

Примеры запроса

Content type
application/json
{
  • "posting_number": "string"
}

Примеры ответа

Content type
application/json
{
  • "posting_number": "string",
  • "products": [
    • {
      • "exemplars": [
        • {
          • "gtd_error_codes": [
            ],
          • "marks": [
            • {
              • "error_codes": [
                ],
              }
            ],
          • "rnpt_error_codes": [
            ]
          }
        ],
      }
    ],
  • "status": "string"
}

Получить статус добавления экземпляров

post
/v4/fbs/posting/product/exemplar/status

Метод для получения статусов добавления экземпляров, переданных в методе /v5/fbs/posting/product/exemplar/set. Также возвращает данные по этим экземплярам.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
string

Номер отправления.

Ответы

Response Schema: application/json
posting_number
string

Номер отправления.

Array of objects

Список товаров.

status
string

Статус проверки всех экземпляров и доступности сборки:

  • ship_available — сборка доступна,
  • ship_not_available — сборка недоступна,
  • validation_in_process — экземпляры на проверке.

Примеры запроса

Content type
application/json
{
  • "posting_number": "23281294-0063-2"
}

Примеры ответа

Content type
application/json
{
  • "posting_number": "23281294-0063-2",
  • "products": [
    • {
      • "exemplars": [
        • {
          }
        ],
      }
    ],
  • "status": "ship_available"
}

Собрать заказ (версия 4)

post
/v4/posting/fbs/ship

Делит заказ на отправления и переводит его в статус awaiting_deliver.

Каждый элемент в packages может содержать несколько элементов products или отправлений. Каждый элемент в products — это товар, включённый в данное отправление.

Разделить заказ нужно, если:

  • товары не помещаются в одну упаковку,
  • товары нельзя сложить в одну упаковку.

Чтобы разделить заказ, передайте в массиве packages несколько объектов.

Пример запроса, когда заказ разделять не нужно: 2 товара будут в одном отправлении.

{
  "packages": [
    {
      "products": [
        {
          "product_id": 185479045,
          "quantity": 2
        }
      ]
    }
  ],
  "posting_number": "89491381-0072-1"
}

Пример запроса, когда заказ нужно разделить: каждый товар будет в отдельном отправлении.

{
  "packages": [
    {
      "products": [
        {
          "product_id": 185479045,
          "quantity": 1
        }
      ]
    },
    {
      "products": [
        {
          "product_id": 185479045,
          "quantity": 1
        }
      ]
    }
  ],
  "posting_number": "89491381-0072-1"
}    

Чтобы внести информацию по экземплярам, используйте метод /v5/fbs/posting/product/exemplar/set.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
required
Array of objects

Список упаковок. Каждая упаковка содержит список отправлений, на которые делится заказ.

posting_number
required
string

Номер отправления.

object

Дополнительная информация.

Ответы

Response Schema: application/json
Array of objects

Дополнительная информация об отправлениях.

result
Array of strings

Результат сборки отправлений.

Примеры запроса

Content type
application/json
{
  • "packages": [
    • {
      • "products": [
        • {
          }
        ]
      }
    ],
  • "posting_number": "89491381-0072-1",
  • "with": {
    }
}

Примеры ответа

Content type
application/json
{
  • "additional_data": [
    • {
      • "products": [
        • {
          • "mandatory_mark": [
            ],
          }
        ]
      }
    ],
  • "result": [
    ]
}

Частичная сборка отправления (версия 4)

post
/v4/posting/fbs/ship/package

Если в запросе передать часть товаров из отправления, метод разделит первичное отправление на две части. В первичном несобранном отправлении останется часть товаров, которую не передали в запросе.

По умолчанию статус созданных отправлений awaiting_packaging — ожидает сборки.

Статус изначального отправления изменится только после изменения статуса отправлений, на которые он разделился.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
string

Номер отправления.

Array of objects

Список товаров в отправлении.

Ответы

Response Schema: application/json
result
string

Номера отправлений, сформированные после сборки.

Примеры запроса

Content type
application/json
{
  • "posting_number": "string",
  • "products": [
    • {
      • "exemplarsIds": [
        ],
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": "string"
}

Обновить данные экземпляров

post
/v1/fbs/posting/product/exemplar/update

Используйте метод после передачи информации по экземплярам методом /v6/fbs/posting/product/exemplar/set, чтобы сохранить обновлённые данные по экземплярам для отправлений в статусе «Ожидает отгрузки».

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
string

Номер отправления.

Ответы

Примеры запроса

Content type
application/json
{
  • "posting_number": "string"
}

Примеры ответа

Content type
application/json
{
  • "code": 0,
  • "details": [
    • {
      }
    ],
  • "message": "string"
}

Доставка FBS

Создание отгрузки

post
/v1/carriage/create

Используйте метод для создания первой FBS отгрузки. В неё попадут все отправления со статусом «Готов к отгрузке». Созданная отгрузка получит статус new.

Для отгрузки в статусе new можно перезаписать состав отправлений методом /v1/carriage/set-postings. Если из отгрузки исключить часть отправлений, они могут попасть в следующую отгрузку.

Чтобы получить список отправлений в отгрузке, используйте метод /v2/posting/fbs/act/get-postings.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
delivery_method_id
integer <int64>

Идентификатор метода доставки.

departure_date
string <date-time>

Дата отгрузки. По умолчанию — текущая дата.

Ответы

Response Schema: application/json
carriage_id
integer <int64>

Идентификатор перевозки.

Примеры запроса

Content type
application/json
{
  • "delivery_method_id": 0,
  • "departure_date": "2019-08-24T14:15:22Z"
}

Примеры ответа

Content type
application/json
{
  • "carriage_id": 0
}

Подтверждение отгрузки

post
/v1/carriage/approve

Используйте метод, чтобы подтвердить отгрузку после её создания. После подтверждения отгрузка перейдёт в статус «Сформирована».

После подтверждения отгрузки вы можете получить лист отгрузки методом /v2/posting/fbs/digital/act/get-pdf и штрихкод отгрузки методом /v2/posting/fbs/act/get-barcode.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
carriage_id
required
integer <int64>

Идентификатор отгрузки.

containers_count
integer <int32>

Количество грузовых мест.

Используйте параметр, если вы подключены к доверительной приёмке и отгружаете заказы грузовыми местами. Если вы не подключены к доверительной приёмке, пропустите его.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "carriage_id": 0,
  • "containers_count": 0
}

Примеры ответа

Content type
application/json
{ }

Список методов доставки и отгрузок

post
/v1/carriage/delivery/list

Используйте метод, чтобы получить список созданных отгрузок для метода доставки и их статусы.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
delivery_method_id
integer <int64>

Идентификатор метода доставки.

departure_date
string <date-time>

Дата отгрузки. По умолчанию — текущая дата.

Ответы

Response Schema: application/json
Array of objects
Array ()
assembly_list_availability
boolean

true, если доступен лист подбора.

can_create_another_carriage
boolean

true, если можно создать ещё одну перевозку.

carriage_postings_count
integer <int32>

Количество отправлений в перевозке.

carriage_quantum_count
integer <int32>

Количество квантов в перевозке.

Array of objects

Список перевозок.

cut_in
string <date-time>

Время начала сборки и часовой пояс времени склада.

delivery_method_id
integer

Идентификатор метода доставки.

delivery_method_name
string

Название метода доставки.

delivery_method_status
string

Статус метода доставки.

departure_date
string <date-time>

Дата отгрузки.

dropoff_address
string

Адрес точки отгрузки.

dropoff_change_availability
string

Статус возможности смены точки отгрузки.

dropoff_point_id
integer <int64>

Идентификатор точки отгрузки.

dropoff_point_type
string

Способ отгрузки.

Array of objects

Массив ошибок, которые возникли при обработке запроса.

first_mile_changing
boolean

true, если точка отгрузки изменилась.

first_mile_type
string

Тип первой мили.

has_entrusted_acceptance
boolean

Признак доверительной приёмки. true, если доверительная приёмка включена на складе.

integration_type
string

Тип интеграции со службой доставки.

is_presort
boolean

true, если отгрузка с предсортировкой.

is_rfbs
boolean

true, если склад работает по схеме rFBS.

recommended_time_local
string

Рекомендуемое местное время отгрузки в пункт приёма заказов.

recommended_time_utc_offset_in_minutes
number <int32>

Смещение часового пояса рекомендуемого времени отгрузки от UTC-0 в минутах.

cutoff_at
string <date-time>

Дата и время, до которых нужно собрать отправление.

mandatory_packaged_count
integer <int32>

Количество «обязательных» собранных отправлений.

mandatory_packaged_quantum_count
integer <int32>

Количество «обязательных» собранных квантов.

mandatory_postings_count
integer <int32>

Количество отправлений, которые нужно собрать.

mandatory_quantum_count
integer <int32>

Количество квантов, которые нужно собрать.

optional_packaged_count
integer <int32>

Количество собранных «необязательных» отправлений.

postings_for_another_carriage_count
integer <int32>

Количество отправлений, которые могут попасть в следующую перевозку.

quantum_for_another_carriage_count
integer <int32>

Количество квантов, которые могут попасть в следующую перевозку.

timeslot_from
string <date-time>

Начало таймслота в точке отгрузки.

timeslot_to
string <date-time>

Окончание таймслота в точке отгрузки.

tpl_provider_icon_url
string

Ссылка на иконку службы доставки.

tpl_provider_name
string

Название службы доставки.

warehouse_city
string

Город склада.

warehouse_id
integer <int64>

Идентификатор склада.

warehouse_name
string

Название склада.

Примеры запроса

Content type
application/json
{
  • "delivery_method_id": 0,
  • "departure_date": "2019-08-24T14:15:22Z"
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "carriages": [
        • {
          }
        ],
      • "errors": [
        • {
          }
        ],
      }
    ]
}

Подтвердить отгрузку и создать документы

post
/v2/posting/fbs/act/create

Подтверждает отгрузку и запускает формирование транспортной накладной и штрихкода для отгрузки. Для продавцов из России также запускается формирование листа отгрузки, а для продавцов из СНГ — акта приёма-передачи.

Чтобы сформировать и получить документы, переведите отправление в статус awaiting_deliver.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
containers_count
integer <int32>

Количество грузовых мест.

Используйте параметр, если вы подключены к доверительной приёмке и отгружаете заказы грузовыми местами. Если вы не подключены к доверительной приёмке, пропустите его.

Подробнее в Базе знаний продавца

delivery_method_id
required
integer <int64>

Идентификатор метода доставки. Можно получить с помощью метода /v1/delivery-method/list.

departure_date
string <date-time>

Дата отгрузки.

Ответы

Response Schema: application/json
object

Результат работы метода.

id
integer <int64>

Номер задания на формирование штрихкода и документов.

Примеры запроса

Content type
application/json
{
  • "containers_count": 1,
  • "delivery_method_id": 230039077005,
  • "departure_date": "2022-06-10T11:42:06.444Z"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Список доступных перевозок

post
/v1/posting/carriage-available/list

Метод для получения перевозок, по которым нужно распечатать штрихкод для отгрузки и документы:

  • для продацов из России — лист отгрузки и транспортную накладную;
  • для продавцов из СНГ — акт и транспортную накладную.
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
delivery_method_id
required
integer <int64>

Фильтр по методу доставки. Можно получить с помощью метода /v1/delivery-method/list.

departure_date
string <date-time>

Дата отгрузки. По умолчанию — текущая дата.

Ответы

Response Schema: application/json
Array of objects

Результат работы метода.

Array ()
carriage_id
integer <int64>

Идентификатор перевозки (также номер задания на формирование документов).

carriage_postings_count
integer <int32>

Количество отправлений в перевозке.

carriage_status
string

Статус перевозки для запрашиваемого метода доставки и даты отгрузки.

cutoff_at
string <date-time>

Дата и время, до которых нужно собрать отправление.

delivery_method_id
integer <int64>

Идентификатор метода доставки.

delivery_method_name
string

Название метода доставки.

Array of objects

Список ошибок.

first_mile_type
string

Тип первой мили.

has_entrusted_acceptance
boolean

Признак доверительной приёмки. true, если доверительная приёмка включена на складе.

mandatory_postings_count
integer <int32>

Количество отправлений, которые нужно собрать.

mandatory_packaged_count
integer <int32>

Количество собранных отправлений.

recommended_time_local
string

Рекомендуемое местное время отгрузки на пункт приёма заказов.

recommended_time_utc_offset_in_minutes
number <int32>

Смещение часового пояса рекомендуемого времени отгрузки от UTC-0 в минутах.

tpl_provider_icon_url
string

Ссылка на иконку службы доставки.

tpl_provider_name
string

Название службы доставки.

warehouse_city
string

Город склада.

warehouse_id
integer <int64>

Идентификатор склада.

warehouse_name
string

Название склада.

warehouse_timezone
string

Часовой пояс, в котором находится склад.

Примеры запроса

Content type
application/json
{
  • "delivery_method_id": 0,
  • "departure_date": "2019-08-24T14:15:22Z"
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "errors": [
        • {
          }
        ],
      }
    ]
}

Информация о перевозке

post
/v1/carriage/get
Request Body schema: application/json
carriage_id
required
integer <int64>

Идентификатор перевозки.

Ответы

Response Schema: application/json
act_type
string

Тип акта приёма-передачи. Актуально для продавцов FBS.

is_waybill_enabled
boolean

true, если доступна печать транспортной накладной.

is_econom
boolean

true, если отгрузка относится к товарам «Суперэконом».

arrival_pass_ids
Array of strings <int64>

Список идентификаторов пропусков, оформленных на перевозку.

available_actions
Array of strings

Доступные действия с перевозкой.

object

Возможность отмены.

carriage_id
integer <int64>

Идентификатор перевозки.

company_id
integer <int64>

Идентификатор продавца.

containers_count
integer <int32>

Количество грузовых мест.

created_at
string <date-time>

Дата создания перевозки.

delivery_method_id
integer <int64>

Идентификатор метода доставки.

departure_date
string

Дата выполнения перевозки.

first_mile_type
string

Тип первой мили.

has_postings_for_next_carriage
boolean

true, если есть отправления, которые не попали в перевозку, но нужно отгрузить.

integration_type
string

Тип перевозки.

is_container_label_printed
boolean

true, если вы уже напечатали этикетки на грузовые места.

is_partial
boolean

true, если перевозка частичная.

partial_num
integer <int64>

Порядковый номер частичной перевозки.

retry_count
integer <int32>

Количество повторных попыток создания перевозки.

status
string

Статус перевозки:

  • received — идёт приёмка,
  • closed — завершена после приёмки,
  • sended — отправлена,
  • cancelled — отменена.
tpl_provider_id
integer <int64>

Идентификатор провайдера доставки.

updated_at
string <date-time>

Дата последнего обновления информации о перевозке.

warehouse_id
integer <int64>

Идентификатор склада.

Примеры запроса

Content type
application/json
{
  • "carriage_id": 0
}

Примеры ответа

Content type
application/json
{
  • "act_type": "string",
  • "is_waybill_enabled": true,
  • "is_econom": true,
  • "arrival_pass_ids": [
    ],
  • "available_actions": [
    ],
  • "cancel_availability": {
    },
  • "carriage_id": 0,
  • "company_id": 0,
  • "containers_count": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "delivery_method_id": 0,
  • "departure_date": "string",
  • "first_mile_type": "string",
  • "has_postings_for_next_carriage": true,
  • "integration_type": "string",
  • "is_container_label_printed": true,
  • "is_partial": true,
  • "partial_num": 0,
  • "retry_count": 0,
  • "status": "string",
  • "tpl_provider_id": 0,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "warehouse_id": 0
}

Разделить заказ на отправления без сборки

post
/v1/posting/fbs/split
Request Body schema: application/json
posting_number
required
string

Номер отправления.

required
Array of objects

Список отправлений, на которые поделится заказ. За один запрос можно разделить один заказ.

Ответы

Response Schema: application/json
object

Информация об изначальном отправлении.

Array of objects

Список отправлений, на которые разделился заказ.

Примеры запроса

Content type
application/json
{
  • "posting_number": "string",
  • "postings": [
    • {
      • "products": [
        • {
          }
        ]
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "parent_posting": {
    • "products": [
      • {
        }
      ]
    },
  • "postings": [
    • {
      • "products": [
        • {
          }
        ]
      }
    ]
}

Список отправлений в акте

post
/v2/posting/fbs/act/get-postings

Возвращает список отправлений в акте по его идентификатору.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
id
required
int <int64>

Идентификатор акта.

Ответы

Response Schema: application/json
Array of objects

Информация об отправлениях.

Array ()
id
integer <int64>

Идентификатор акта.

multi_box_qty
integer <int32>

Количество коробок, в которые упакован товар.

posting_number
string

Номер отправления.

status
string

Статус отправления.

seller_error
string

Расшифровка кода ошибки.

updated_at
string <date-time>

Дата и время обновления записи об отправлении.

created_at
string <date-time>

Дата и время создания записи об отправлении.

Array of objects

Список товаров в отправлении.

Примеры запроса

Content type
application/json
{
  • "id": 900000250859000
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "products": [
        • {
          }
        ]
      }
    ]
}

Этикетки для грузового места

post
/v2/posting/fbs/act/get-container-labels

Метод создает этикетки для грузового места.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
id
required
integer <int64>

Номер задания на формирование документов (также идентификатор перевозки) из метода POST /v2/posting/fbs/act/create.

Ответы

Response Schema: application/pdf
file_content
string <byte>

Содержание файла в бинарном виде.

file_name
string

Название файла.

content_type
string

Тип файла.

Примеры запроса

Content type
application/json
{
  • "id": 295662811
}

Примеры ответа

Content type
application/pdf
{
  "content_type": "application/pdf",
  "file_name": "carriage-containers-20903594.pdf",
  "file_content": "%PDF-1.4\n%âãÏÓ\n2 0 obj\n<</Length 2992/Filter/FlateDecode>>stream\nxœµ}[ێ\u001c·\u0011}Ÿ¯èç\u0000¦Èb\u0015/€ @»+\u0019y0Ë\u0002ù\u0000%q\u0010X\u0001ìü?Ãn²ÉéfÍì(ò®\u001duMÝ/<Å\u0019\u001bòyýY,0Ã?=[ccyýåëå×K¡§˜\u000bAÂâ؉‰x\u001d—ßþqùÛ\u001f–ÿà-dœp¢UÔø\u001aün)¿ùqÙ^üöóåݏùù¿«X¶i\t²JúçåÏøýõ’Ù$Gxn—²\u0011&\u000f¥ÉCj¾§2‹aŽ‘æºr&­^™˜,~hI²)ŒF¤ùŒ7¥íu£:oˆÊ\u0013Ùȹ0ûLdB\u001a\u0018y§xkˆ;ë<^Lv›)%¼)í\u0014ö†cyó”ÎX:\u0018ÚõI‰Xå\u0015\u0013╏\r…õɌ5d“ýÆ\u0016ŠÊ!6Ñpysš\u001a”ÄXYÃ1“š­‰Ô\r:H†©(%U´³bR"
}

Штрихкод для отгрузки отправления

post
/v2/posting/fbs/act/get-barcode

Метод для получения штрихкода, который нужно показать в пункте выдачи или сортировочном центре при отгрузке отправления.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
id
required
integer <int64>

Идентификатор перевозки.

Ответы

Response Schema: image/png
file_content
string

Изображение со штрихкодом в бинарном виде.

file_name
string

Название файла.

content_type
string

Тип файла.

Примеры запроса

Content type
application/json
{
  • "id": "295662811"
}

Примеры ответа

Content type
image/png
{
  "content_type": "image/png",
  "file_name": "20913984_barcode.png",
  "file_content": "‰PNG\r\n\u001a\n\u0000\u0000\u0000\rIHDR\u0000\u0000\u0003\u0010\u0000\u0000\u0000\u0010\u0000\u0000\u0000\u0000íZ\u000e'\u0000\u0000\u0002pIDATxœìÕÁJ\u00031\u0014@Q+þÿ/×E\u0017\u000e¼›\u0010u¡-ç¬$£Éˌp?î÷·§t» }ýü¸ÃcåzŸ¹2w˜OWû\\Ϛ뫧×Ùö;œì|rÇýßîç¼úî{˜§¬N?™í7oì•v¸®Ÿµ¹Ãù„û•¹¾ÿÏ9ÿî?›až¸ºéê7O&߿É9çÉ\u000eÏáý¯\u0007\u0000à\u0012\b\u0000’@\u0000\u0004\u0002€$\u0010\u0000$\u0000 \t\u0004\u0000I \u0000H\u0002\u0001@\u0012\b\u0000’@\u0000\u0004\u0002€$\u0010\u0000$\u0000 \t\u0004\u0000I \u0000H\u0002\u0001@\u0012\b\u0000’@\u0000\u0004\u0002€$\u0010\u0000$\u0000 \t\u0004\u0000I \u0000H\u0002\u0001@\u0012\b\u0000’@\u0000\u0004\u0002€$\u0010\u0000$\u0000 \t\u0004\u0000I \u0000H\u0002\u0001@\u0012\b\u0000’@\u0000\u0004\u0002€$\u0010\u0000"
}

Значение штрихкода для отгрузки отправления

post
/v2/posting/fbs/act/get-barcode/text

Используйте этот метод, чтобы получить штрихкод из ответа /v2/posting/fbs/act/get-barcode в текстовом виде.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
id
required
integer <int64>

Идентификатор перевозки.

Ответы

Response Schema: application/json
result
string

Штрихкод в текстовом виде.

Примеры запроса

Content type
application/json
{
  • "id": "295662811"
}

Примеры ответа

Content type
application/json
{
  • "result": "%303%24276481394"
}

Статус формирования накладной

post
/v2/posting/fbs/digital/act/check-status
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
id
required
integer <int64>

Номер задания на формирование документов (также идентификатор перевозки) из метода POST /v2/posting/fbs/act/create.

Ответы

Response Schema: application/json
id
integer <int64>

Номер задания на формирование документов.

status
string

Cтатус формирования документов:

  • FORMING — ещё не готовы,
  • FORMED — сформированы успешно,
  • CONFIRMED — подписаны Ozon,
  • CONFIRMED_WITH_MISMATCH — подписаны Ozon с расхождениями,
  • NOT_FOUND — документы не найдены,
  • UNKNOWN_ERROR — произошла ошибка.

Примеры запроса

Content type
application/json
{
  • "id": 0
}

Примеры ответа

Content type
application/json
{
  • "id": 0,
  • "status": "string"
}

Получить PDF c документами

post
/v2/posting/fbs/act/get-pdf

С помощью метода можно получить:

  • продацам из России — лист отгрузки и транспортную накладную;
  • продавцам из СНГ — акт и транспортную накладную.
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
id
required
integer <int64>

Номер задания на формирование документов (также идентификатор перевозки) из метода POST /v2/posting/fbs/act/create.

Ответы

Response Schema: application/pdf
file_content
string <byte>

Содержание файла в бинарном виде.

file_name
string

Название файла.

content_type
string

Тип файла.

Примеры запроса

Content type
application/json
{
  • "id": 22435521842000
}

Примеры ответа

Content type
application/pdf
{
  "content_type": "application/pdf",
  "file_name": "20928233.pdf",
  "file_content": "%PDF-1.4\n%âãÏÓ\n2 0 obj\n<</Length 13528/Filter/FlateDecode>>stream\nxœí }[ ¯ä:vÞ{ ÿŠz\u000e{ { { }\\\\x1d\\\\xde/\\\\xc0{ } } }€ ]µw\u000fò` “9€ój8ö\u0000†í$¶\u0003ä燔D‰º|\"—еo ]ÝØ})•D‘\\\\÷õ­NHßÿº°ðûoºì¿NñÎsïÝå\u001fþõÇÿù\u0011¯\u000be}ǍÑ\u0017©™í¤4âòïÿøãïþËåßÂ7dÇ\u0014÷BðþYËÿ…GðKüýßÿt\u0019þñïýñ۟äå¯ÿÑ?Ùq}\u0011’Éø¸ê?añ«Ã?ú¯ªøÕN_”\r8®.œ9\u0013¿þ—\u001fáÜ]ò?íÛ\u000fç\u0011•½Há/V°ø\"qÄø‰–«O”\\G\u000bµþDëõ'έ>ñ|}——ëïpÆÅæ#³\u0018?ܣDxM—>èT?¹ìÏ8ï͇aÞ×ßüöß.øÃo{û¯¯"
}

Список актов по отгрузкам

post
/v2/posting/fbs/act/list

Возвращает список актов по отгрузкам с возможностью отфильтровать отгрузки по периоду, статусу и типу интеграции.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Параметры фильтра.

limit
required
integer <int64>

Максимальное количество актов в ответе.

Ответы

Response Schema: application/json
Array of objects

Результат запроса.

Array ()
id
int <int64>

Идентификатор отгрузки.

delivery_method_id
int <int64>

Идентификатор метода доставки.

delivery_method_name
string

Название метода доставки.

integration_type
string

Тип интеграции со службой доставки:

  • ozon — доставка через Ozon логистику.
  • 3pl — доставка внешней службой, продавец регистрирует заказ.
containers_count
int <int32>

Число грузовых мест.

status
string

Статус отгрузки.

departure_date
string

Дата отгрузки.

created_at
string <date-time>

Дата создания записи об отгрузке.

updated_at
string <date-time>

Дата обновления записи об отгрузке.

act_type
string

Тип акта приёма-передачи для FBS продавцов.

is_partial
boolean

Признак частичной перевозки. true, если перевозка частичная.

Частичная перевозка значит, что отгрузка была разделена на несколько частей и по каждой из частей формируются отдельные акты.

has_postings_for_next_carriage
boolean

Признак наличия подлежащих отгрузке отправлений, которые не попали в текущую перевозку. true, если такие отправления есть.

partial_num
integer <int64>

Порядковый номер частичной перевозки.

object

Информация про акты перевозки.

Примеры запроса

Content type
application/json
{
  • "filter": {
    • "status": [
      ]
    },
  • "limit": 100
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "related_docs": {
        • "act_of_acceptance": {
          },
        • "act_of_mismatch": {
          },
        • "act_of_excess": {
          }
        }
      }
    ]
}

Получить лист отгрузки по перевозке

post
/v2/posting/fbs/digital/act/get-pdf

Вы можете получить документы, если в ответе метода /v2/posting/fbs/digital/act/check-status был один из статусов:

  • FORMED — перевозка сформирована успешно,
  • CONFIRMED — перевозка подтверждена Ozon,
  • CONFIRMED_WITH_MISMATCH — перевозка принята Ozon с расхождениями.
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
id
required
integer <int64>

Номер задания на формирование документов (также идентификатор перевозки) из метода POST /v2/posting/fbs/act/create.

doc_type
any <string>

Тип электронного документа:

  • act_of_acceptance — лист отгрузки,
  • act_of_mismatch — акт о расхождениях,
  • act_of_excess — акт об излишках.

Ответы

Response Schema: application/pdf
file_content
string <byte>

Содержание файла в бинарном виде.

file_name
string

Название файла.

content_type
string

Тип файла.

Примеры запроса

Content type
application/json
{
  • "id": 900000250859000,
  • "doc_type": "act_of_acceptance"
}

Примеры ответа

Content type
application/pdf
{
  "content_type": "application/pdf",
  "file_name": "20816409_act_of_mismatch.pdf",
  "file_content": "%PDF-1.4\n%ÓôÌá\n1 0 obj\n<<\n/Creator(Chromium)\n/Producer(PDFsharp 1.50.5147 \\([www.pdfsharp.com|http://www.pdfsharp.com/]\\) \\(Original: Skia/PDF m103\\))\n/CreationDate(D:20230625092529+00'00')\n/ModDate(D:20230625092529+00'00')\n>>\nendobj\n2 0 obj\n<<\n/Type/Page\n/Resources\n<<\n/ProcSet[/PDF/Text/ImageB/ImageC/ImageI]\n/ExtGState\n<<\n/G3 3 0 R\n/G8 8 0 R\n>>\n/XObject\n<<\n/X6 6 0 R\n/X7 7 0 R\n>>\n/Font\n<<\n/F4 4 0 R\n/F5 5 0 R\n>>\n>>\n/MediaBox[0 0 594.96 841.92]\n/Contents 9 0 R\n/StructParents 0\n/Parent 13 0 R\n/Group\n<<\n/CS/DeviceRGB\n/S/Transparency\n>>\n>>\nendobj\n3 0 obj\n<<\n/ca 1\n/BM/Normal\n>>\nendobj\n4 0 obj\n<<\n/Type/Font\n/Subtype/Type0\n/BaseFont/AAAAAA+LiberationSans\n/Encoding/Identity-H\n/DescendantFonts[160 0 R]\n/ToUnicode 161 0 R\n>>\nendobj\n5 0 obj\n<<\n/Type/Font\n/Subtype/Type0\n/BaseFont/BAAAAA+LiberationSans-Bold\n/Encoding/Identity-H\n/DescendantFonts[164 0"
}

Статус отгрузки и документов

post
/v2/posting/fbs/act/check-status

Возвращает статус формирования штрихкода для отгрузки и документов:

  • для продавцов из России — транспортной накладной и листа отгрузки;
  • для продавцов из СНГ — транспортной накладной и акта приёма-передачи.
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
id
required
integer <int64>

Номер задания на формирование документов (также идентификатор перевозки) из метода POST /v2/posting/fbs/act/create.

Ответы

Response Schema: application/json
object

Результат работы метода.

act_type
string

Тип документов.

Если значение ozon_digital, используйте методы /v2/posting/fbs/digital/act/check-status и /v2/posting/fbs/digital/act/get-pdf для получения электронной транспортной накладной.

added_to_act
Array of strings

Массив c номерами отправлений, которые добавлены в перевозку. Эти отправления нужно передать сегодня.

removed_from_act
Array of strings

Массив с номерами отправлений, которые не попали в перевозку. Такие отправления нужно передавать со следующей отгрузкой.

status
string

Статус запроса:

  • in_process — документы формируются, нужно подождать.
  • ready — документы сформированы и готовы для скачивания.
  • error — произошла ошибка при формировании документов, запросите документы повторно.
  • cancelled — создание документов отменено, запросите их повторно.
  • The next postings aren't ready — произошла ошибка, отправления не включены в отгрузку. Подождите некоторое время и проверьте результат запроса. Если ошибка повторяется, обратитесь в службу поддержки.
is_partial
boolean

Признак частичной перевозки. true, если перевозка частичная.

Частичная перевозка значит, что отгрузка была разделена на несколько частей.

has_postings_for_next_carriage
boolean

true, если есть отправления, не попавшие в текущую перевозку, но которые нужно отгрузить.

Если в ответе вернулось true, подтвердите отгрузку или создайте новый акт через метод /v2/posting/fbs/act/create и проверьте их статус. Повторяйте действия, пока в ответе не вернётся false.

partial_num
integer <int64>

Порядковый номер частичной перевозки.

Примеры запроса

Content type
application/json
{
  • "id": 900000250859000
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "added_to_act": [
      ],
    • "removed_from_act": [
      ],
    }
}

Доставка rFBS

Добавить трек-номера

post
/v2/fbs/posting/tracking-number/set

Добавить трек-номера к отправлениям. Вы можете передать до 20 трек-номеров за раз.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
required
Array of objects

Массив с парами идентификатор отправления — трек-номер.

Ответы

Response Schema: application/json
Array of objects

Результат работы метода.

Array ()
error
string

Ошибка при обработке запроса.

posting_number
string

Номер отправления.

result
boolean

Если запрос выполнен без ошибок — true.

Примеры запроса

Content type
application/json
{
  • "tracking_numbers": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Изменить статус на «Отправлено продавцом»

post
/v2/fbs/posting/sent-by-seller

Перевести отправление в статус «Отправлено продавцом». Статус доступен только продавцам с первой милей, продающим из-за рубежа.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
Array of strings

Список идентификаторов отправлений.

Ответы

Response Schema: application/json
Array of objects

Результат работы метода.

Array ()
error
string

Ошибка.

posting_number
string

Идентификатор отправления.

result
boolean

Примеры запроса

Content type
application/json
{
  • "posting_number": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Изменить статус на «Доставляется»

post
/v2/fbs/posting/delivering

Перевести отправление в статус «Доставляется», если используется сторонняя служба доставки.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
Array of strings

Идентификатор отправления.

Ответы

Response Schema: application/json
Array of objects

Результат работы метода.

Array ()
error
string

Ошибка при обработке запроса.

posting_number
string

Номер отправления.

result
boolean

Если запрос выполнен без ошибок — true.

Примеры запроса

Content type
application/json
{
  • "posting_number": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Изменить статус на «Последняя миля»

post
/v2/fbs/posting/last-mile

Перевести отправление в статус «Последняя миля», если используется сторонняя служба доставки.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
Array of strings

Идентификатор отправления.

Ответы

Response Schema: application/json
Array of objects

Результат работы метода.

Array ()
error
string

Ошибка при обработке запроса.

posting_number
string

Номер отправления.

result
boolean

Если запрос выполнен без ошибок — true.

Примеры запроса

Content type
application/json
{
  • "posting_number": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Изменить статус на «Доставлено»

post
/v2/fbs/posting/delivered

Перевести отправление в статус «Доставлено», если используется сторонняя служба доставки.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
Array of strings

Идентификатор отправления.

Ответы

Response Schema: application/json
Array of objects

Результат работы метода.

Array ()
error
string

Ошибка при обработке запроса.

posting_number
string

Номер отправления.

result
boolean

Если запрос выполнен без ошибок — true.

Примеры запроса

Content type
application/json
{
  • "posting_number": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Доступные даты для переноса доставки

post
/v1/posting/fbs/timeslot/change-restrictions

Метод для получения доступных дат для переноса доставки и количества доступных переносов.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
string

Номер отправления.

Ответы

Response Schema: application/json
object

Период дат, доступных для переноса.

remaining_changes_count
integer <int64>

Количество оставшихся переносов.

Примеры запроса

Content type
application/json
{
  • "posting_number": "string"
}

Примеры ответа

Content type
application/json
{
  • "delivery_interval": {
    },
  • "remaining_changes_count": 0
}

Перенести дату доставки

post
/v1/posting/fbs/timeslot/set

Вы можете изменить дату доставки отправления не больше двух раз.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
required
object

Новый период для даты доставки.

posting_number
required
string

Номер отправления.

Ответы

Response Schema: application/json
result
boolean

true, если дата изменена.

Примеры запроса

Content type
application/json
{
  • "new_timeslot": {
    },
  • "posting_number": "string"
}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Уточнить дату отгрузки отправления

post
/v1/posting/cutoff/set

Метод для отправлений, которые доставляет продавец или неинтегрированный перевозчик.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
new_cutoff_date
required
string <date-time>

Новая дата отгрузки.

posting_number
required
string

Номер отправления.

Ответы

Response Schema: application/json
result
boolean

true, если установлена новая дата.

Примеры запроса

Content type
application/json
{
  • "new_cutoff_date": "2019-08-24T14:15:22Z",
  • "posting_number": "string"
}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Пропуски

Список пропусков

post
/v1/pass/list
Request Body schema: application/json
cursor
string

Указатель для выборки следующих данных.

object

Фильтры.

limit
required
integer <int32>

Ограничение по количеству записей в ответе. По умолчанию — 1000. Максимум — 1000.

Ответы

Response Schema: application/json
Array of objects

Список пропусков для перевозки.

cursor
string

Указатель для выборки следующих данных. Если параметр пустой, данных больше нет.

Примеры запроса

Content type
application/json
{
  • "cursor": "string",
  • "filter": {
    • "arrival_pass_ids": [
      ],
    • "dropoff_point_ids": [
      ],
    • "warehouse_ids": [
      ]
    },
  • "limit": 0
}

Примеры ответа

Content type
application/json
{
  • "arrival_passes": [
    • {
      • "arrival_reasons": [
        ],
      }
    ],
  • "cursor": "string"
}

Создать пропуск

post
/v1/carriage/pass/create

Идентификатор созданного пропуска добавится к перевозке.

Request Body schema: application/json
required
Array of objects

Список пропусков.

carriage_id
required
integer <int64>

Идентификатор перевозки.

Ответы

Response Schema: application/json
arrival_pass_ids
Array of strings <int64>

Идентификаторы пропусков.

Примеры запроса

Content type
application/json
{
  • "arrival_passes": [
    • {
      }
    ],
  • "carriage_id": 0
}

Примеры ответа

Content type
application/json
{
  • "arrival_pass_ids": [
    ]
}

Обновить пропуск

post
/v1/carriage/pass/update
Request Body schema: application/json
required
Array of objects

Список пропусков.

carriage_id
required
integer <int64>

Идентификатор перевозки.

Ответы

Response Schema: application/json
object

Пропуск обновлён

Примеры запроса

Content type
application/json
{
  • "arrival_passes": [
    • {
      }
    ],
  • "carriage_id": 0
}

Примеры ответа

Content type
application/json
{ }

Удалить пропуск

post
/v1/carriage/pass/delete
Request Body schema: application/json
arrival_pass_ids
required
Array of strings <int64>

Идентификаторы пропусков.

carriage_id
required
integer <int64>

Идентификатор перевозки.

Ответы

Response Schema: application/json
object

Пропуск удалён

Примеры запроса

Content type
application/json
{
  • "arrival_pass_ids": [
    ],
  • "carriage_id": 0
}

Примеры ответа

Content type
application/json
{ }

Создать пропуск для возврата

post
/v1/return/pass/create
Request Body schema: application/json
required
Array of objects

Список пропусков.

Ответы

Response Schema: application/json
arrival_pass_ids
Array of strings <int64>

Идентификаторы пропусков.

Примеры запроса

Content type
application/json
{
  • "arrival_passes": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{
  • "arrival_pass_ids": [
    ]
}

Обновить пропуск для возврата

post
/v1/return/pass/update
Request Body schema: application/json
required
Array of objects

Список пропусков.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "arrival_passes": [
    • {
      }
    ]
}

Примеры ответа

Content type
application/json
{ }

Удалить пропуск для возврата

post
/v1/return/pass/delete
Request Body schema: application/json
arrival_pass_ids
required
Array of strings <int64>

Идентификаторы пропусков.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "arrival_pass_ids": [
    ]
}

Примеры ответа

Content type
application/json
{ }

Возвраты товаров FBO и FBS

Информация о возвратах FBO и FBS

post
/v1/returns/list

Метод для получения информации о возвратах FBO и FBS.

Request Body schema: application/json
object

Фильтры. Используйте только один фильтр в запросе: logistic_return_date, storage_tariffication_start_date или visual_status_change_moment, иначе вернётся ошибка.

limit
required
integer <int32>

Количество подгружаемых возвратов. Максимальное значение — 500.

last_id
integer <int64>

Идентификатор последнего подгруженного возврата.

Ответы

Response Schema: application/json
Array of objects

Информация о возвратах.

has_next
boolean

true, если у продавца есть другие возвраты.

Примеры запроса

Content type
application/json
{
  • "filter": {
    • "logistic_return_date": {
      },
    • "storage_tariffication_start_date": {
      },
    • "visual_status_change_moment": {
      },
    • "posting_numbers": [
      ],
    },
  • "limit": 500,
  • "last_id": 0
}

Примеры ответа

Content type
application/json
{
  • "returns": [
    • {
      • "exemplars": [
        • {
          }
        ],
      • "place": {
        },
      • "target_place": {
        },
      • "storage": {
        • "sum": {
          },
        • "utilization_sum": {
          },
        },
      • "product": {
        • "price": {
          },
        • "price_without_commission": {
          },
        • "commission": {
          },
        },
      • "logistic": {
        },
      • "visual": {
        • "status": {
          },
        },
      • "additional_info": {
        },
      }
    ],
  • "has_next": false
}

Возвраты товаров rFBS

Список заявок на возврат

post
/v2/returns/rfbs/list
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Фильтр.

last_id
integer <int32>

Идентификатор последнего значения на странице. Оставьте это поле пустым при выполнении первого запроса.

limit
required
integer <int32>

Количество значений в ответе.

Ответы

Response Schema: application/json
object

Данные о заявках.

client_name
string

Имя покупателя.

created_at
string <date-time>

Дата создания заявки.

order_number
string

Номер заказа.

posting_number
string

Номер отправления.

object

Данные о товаре.

return_id
integer <int64>

Идентификатор заявки на возврат.

return_number
string

Номер заявки на возврат.

object

Статусы заявки и возврата денег.

Примеры запроса

Content type
application/json
{
  • "filter": {
    • "group_state": [
      ],
    • "created_at": {
      }
    },
  • "last_id": 0,
  • "limit": 0
}

Примеры ответа

Content type
application/json
{
  • "returns": {
    • "product": {
      },
    • "state": {
      }
    }
}

Информация о заявке на возврат

post
/v2/returns/rfbs/get
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
return_id
required
integer <int64>

Идентификатор заявки.

Ответы

Response Schema: application/json
object

Данные о заявке.

Array of objects

Данные о доступных действиях с заявкой.

client_name
string

Имя покупателя.

client_photo
Array of strings

Ссылки на фотографии товара.

object

Данные о способе возврата.

comment
string

Комментарий покупателя.

created_at
string <date-time>

Дата создания заявки.

order_number
string

Номер заказа.

posting_number
string

Номер отправления.

object

Данные о товаре.

rejection_comment
string

Комментарий об отклонении заявки.

Array of objects

Данные о причине отклонения заявки.

return_method_description
string

Способ возврата товара.

return_number
string

Номер заявки на возврат.

object

Данные о причине возврата.

ru_post_tracking_number
string

Трек-номер почтового отправления.

object

Данные о статусе возврата.

warehouse_id
integer <int64>

Идентификатор склада.

Примеры запроса

Content type
application/json
{
  • "return_id": 0
}

Примеры ответа

Content type
application/json
{
  • "returns": {
    • "available_actions": [
      • {
        }
      ],
    • "client_photo": [
      ],
    • "client_return_method_type": {
      },
    • "product": {
      },
    • "rejection_reason": [
      • {
        }
      ],
    • "return_reason": {
      },
    • "state": {
      },
    }
}

Отклонить заявку на возврат

post
/v2/returns/rfbs/reject

Метод позволяет отклонить заявку на возврат rFBS-заказа. Вы можете объяснить своё решение в параметре comment.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
return_id
required
integer <int64>

Идентификатор заявки на возврат.

comment
string

Комментарий.

Передайте комментарий, если в ответе метода /v2/returns/rfbs/get параметр rejection_reason.is_comment_requiredtrue.

rejection_reason_id
required
integer <int64>

Идентификатор причины отмены.

Передайте идентификатор из списка причин, полученного в ответе метода /v2/returns/rfbs/get в параметре rejection_reason.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "return_id": 0,
  • "comment": "string",
  • "rejection_reason_id": 0
}

Примеры ответа

Content type
application/json
{ }

Вернуть часть стоимости товара

post
/v2/returns/rfbs/compensate

Метод для частичной компенсации стоимости товара: вы возвращаете часть денег покупателю, товар остаётся у него.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
compensation_amount
string

Сумма компенсации.

return_id
required
integer <int64>

Идентификатор заявки на возврат.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "compensation_amount": "string",
  • "return_id": 0
}

Примеры ответа

Content type
application/json
{ }

Одобрить заявку на возврат

post
/v2/returns/rfbs/verify

Метод позволяет одобрить заявку и согласиться на получение товара для проверки.

Подтвердите получение товара с помощью метода /v2/returns/rfbs/receive-return.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
return_id
required
integer <int64>

Идентификатор заявки на возврат.

return_method_description
string

Способ возврата товара.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "return_id": 0,
  • "return_method_description": "string"
}

Примеры ответа

Content type
application/json
{ }

Подтвердить получение товара на проверку

post
/v2/returns/rfbs/receive-return
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
return_id
required
integer <int64>

Идентификатор заявки на возврат.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "return_id": 0
}

Примеры ответа

Content type
application/json
{ }

Вернуть деньги покупателю

post
/v2/returns/rfbs/return-money

Метод подтверждает возврат полной стоимости товара. Используйте метод, если согласны:

  • сразу вернуть стоимость товара и оставить его покупателю;
  • вернуть стоимость после получения и проверки товара.

Если товар оказался ненадлежащего качества или с браком, вы возмещаете покупателю стоимость пересылки товара.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
return_id
required
integer <int64>

Идентификатор заявки на возврат.

return_for_back_way
integer <int64>

Сумма, возмещаемая покупателю за пересылку товара.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "return_id": 0,
  • "return_for_back_way": 0
}

Примеры ответа

Content type
application/json
{ }

Возвратные отгрузки

Количество возвратов FBS

post
/v1/returns/company/fbs/info

Метод для получения информации о возвратах FBS и их количестве.

Request Body schema: application/json
object

Фильтры.

required
object

Разделение ответа метода.

Ответы

Response Schema: application/json
Array of objects

Информация о drop-off пунктах.

has_next
boolean

Признак, есть ли ещё пункты, где продавца ожидают возвраты.

Примеры запроса

Content type
application/json
{
  • "filter": {
    },
  • "pagination": {
    }
}

Примеры ответа

Content type
application/json
{
  • "drop_off_points": [
    • {
      • "pass_info": {
        },
      • "warehouses_ids": [
        ]
      }
    ],
  • "has_next": true
}

Проверить возможность получения возвратных отгрузок по штрихкоду

post
/v1/return/giveout/is-enabled

Если у вас есть доступ, в параметре enabled будет указано значение true.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Ответы

Response Schema: application/json
enabled
boolean

true, если вы можете получить возвратную отгрузку по штрихкоду.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
application/json
{
  • "enabled": true
}

Список возвратных отгрузок

post
/v1/return/giveout/list

Метод для получения списка активных возвратов. Возвратная отгрузка становится активной после сканирования штрихкода. После сканирования штрихкода второй раз активная выдача переходит в статус неактивной.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
last_id
integer <int64>

Идентификатор последнего значения на странице.

limit
required
integer <int64>

Количество элементов в ответе.

Ответы

Response Schema: application/json
Array of objects

Идентификатор отгрузки.

Array ()
approved_articles_count
integer <int32>

Количество товаров в отгрузке.

created_at
string <date-time>

Дата и время.

giveout_id
integer <int64>

Идентификатор отгрузки.

giveout_status
string

Статусы возвратной отгрузки:

  • GIVEOUT_STATUS_UNSPECIFIED — не определён, напишите в поддержку.
  • GIVEOUT_STATUS_CREATED — создана.
  • GIVEOUT_STATUS_APPROVED — одобрена.
  • GIVEOUT_STATUS_COMPLETED — завершена.
  • GIVEOUT_STATUS_CANCELLED — отменена.
total_articles_count
integer <int32>

Общее количество товаров, которые нужно забрать со склада.

warehouse_address
string

Адрес склада.

warehouse_id
integer <int64>

Идентификатор склада.

warehouse_name
string

Название склада.

Примеры запроса

Content type
application/json
{
  • "last_id": 0,
  • "limit": 0
}

Примеры ответа

Content type
application/json
{
  • "giveouts": [
    • {
      }
    ]
}

Информация о возвратной отгрузке

post
/v1/return/giveout/info

Метод для получения информации о возвратной отгрузке. В параметр giveout_id передаётся значение, полученное в методе /v1/return/giveout/list.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
giveout_id
required
integer <int64>

Идентификатор отгрузки.

Ответы

Response Schema: application/json
Array of objects

Артикулы товаров.

giveout_id
integer <int64>

Идентификатор отгрузки.

giveout_status
string

Статусы возвратной отгрузки:

  • GIVEOUT_STATUS_UNSPECIFIED — не определён, напишите в поддержку.
  • GIVEOUT_STATUS_CREATED — создана.
  • GIVEOUT_STATUS_APPROVED — одобрена.
  • GIVEOUT_STATUS_COMPLETED — завершена.
  • GIVEOUT_STATUS_CANCELLED — отменена.
warehouse_address
string

Адрес склада.

warehouse_name
string

Название склада.

Примеры запроса

Content type
application/json
{
  • "giveout_id": 0
}

Примеры ответа

Content type
application/json
{
  • "articles": [
    • {
      }
    ],
  • "giveout_id": 0,
  • "giveout_status": "string",
  • "warehouse_address": "string",
  • "warehouse_name": "string"
}

Значение штрихкода для возвратных отгрузок

post
/v1/return/giveout/barcode

Используйте этот метод, чтобы получить штрихкод из ответа методов /v1/return/giveout/get-png и /v1/return/giveout/get-pdf в текстовом виде.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Ответы

Response Schema: application/json
barcode
string

Значение штрихкода в текстовом виде.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
application/json
{
  • "barcode": "string"
}

Штрихкод для получения возвратной отгрузки в формате PDF

post
/v1/return/giveout/get-pdf

Возвращает PDF-файл со штрихкодом. Метод работает только для схемы FBS.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Ответы

Response Schema: application/pdf
file_content
string

PDF-файл со штрихкодом в бинарном виде.

file_name
string

Название файла.

content_type
string

Тип файла.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
application/pdf
{
  "content_type": "application/pdf",
  "file_name": "string",
  "file_content": "string"
}

Штрихкод для получения возвратной отгрузки в формате PNG

post
/v1/return/giveout/get-png

Возвращает PNG-файл со штрихкодом.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Ответы

Response Schema: image/png
file_content
string

PNG-файл со штрихкодом в бинарном виде.

file_name
string

Название файла.

content_type
string

Тип файла.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
image/png
{
  "content_type": "image/png",
  "file_name": "string",
  "file_content": "string"
}

Сгенерировать новый штрихкод

post
/v1/return/giveout/barcode-reset

Используйте метод, если ваш штрихкод попал в посторонние руки.

Метод возвращает PNG-файл с новым штрихкодом. После использования метода вы не сможете получить возвратную отгрузку по старым штрихкодам. Чтобы получить новый штрихкод в PDF-формате, запросите его методом /v1/return/giveout/get-pdf.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Ответы

Response Schema: image/png
file_content
string

Изображение со штрихкодом в бинарном виде.

file_name
string

Название файла.

content_type
string

Тип файла.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
image/png
{
  "content_type": "image/png",
  "file_name": "string",
  "file_content": "string"
}

Отмены заказов

Получить информацию о заявке на отмену rFBS

post
/v1/conditional-cancellation/get

Метод для получения информации о заявке на отмену rFBS-заказа.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
cancellation_id
required
integer <int64>

Идентификатор заявки на отмену.

Ответы

Response Schema: application/json
object

Результат запроса.

cancellation_id
integer <int64>

Идентификатор заявки на отмену.

posting_number
string

Номер отправления.

object

Причина отмены.

cancelled_at
string <date-time>

Дата создания заявки на отмену.

cancellation_reason_message
string

Комментарий к заявке на отмену, введённый инициатором отмены вручную.

tpl_integration_type
string

Тип интеграции со службой доставки.

object

Статус заявки на отмену.

cancellation_initiator
string
Enum: "OZON" "SELLER" "CLIENT" "SYSTEM" "DELIVERY"

Инициатор отмены:

  • OZON — Ozon,
  • SELLER — продавец,
  • CLIENT — покупатель,
  • SYSTEM — система,
  • DELIVERY — служба доставки.
order_date
string <date-time>

Дата создания заказа.

approve_comment
string

Комментарий, оставленный при подтверждении или отклонении заявки на отмену.

approve_date
string <date-time>

Дата подтверждения или отклонения заявки на отмену.

auto_approve_date
string <date-time>

Дата, после которой заявка будет автоматически подтверждена.

Примеры запроса

Content type
application/json
{
  • "cancellation_id": 90066344
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "cancellation_reason": {
      },
    • "state": {
      },
    }
}

Получить список заявок на отмену rFBS

post
/v1/conditional-cancellation/list

Метод для получения списка заявок на отмену rFBS-заказов.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Фильтры.

limit
required
integer <int32>

Количество заявок в ответе.

offset
integer <int32>

Количество элементов, которое будет пропущено в ответе. Например, если offset=10, ответ начнётся с 11-го найденного элемента.

object

Дополнительная информация.

Ответы

Response Schema: application/json
Array of objects

Список заявок на отмену.

Array ()
cancellation_id
integer <int64>

Идентификатор заявки на отмену.

posting_number
string

Номер отправления.

object

Причина отмены.

cancelled_at
string <date-time>

Дата создания заявки на отмену.

cancellation_reason_message
string

Комментарий к заявке на отмену, введённый инициатором отмены вручную.

tpl_integration_type
string

Тип интеграции со службой доставки.

object

Статус заявки на отмену.

cancellation_initiator
string
Enum: "OZON" "SELLER" "CLIENT" "SYSTEM" "DELIVERY"

Инициатор отмены:

  • OZON — Ozon,
  • SELLER — продавец,
  • CLIENT — покупатель,
  • SYSTEM — система,
  • DELIVERY — служба доставки.
order_date
string <date-time>

Дата создания заказа.

approve_comment
string

Комментарий, оставленный при подтверждении или отклонении заявки на отмену.

approve_date
string <date-time>

Дата подтверждения или отклонения заявки на отмену.

auto_approve_date
string <date-time>

Дата, после которой заявка будет автоматически подтверждена.

total
integer <int32>

Общее количество заявок по заданным фильтрам.

object

Cчётчик заявок в разных статусах.

Примеры запроса

Content type
application/json
{
  • "filters": {
    • "cancellation_initiator": [
      ],
    },
  • "limit": 2,
  • "offset": 0,
  • "with": {
    }
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "cancellation_reason": {
        },
      • "state": {
        },
      },
    • {
      • "cancellation_reason": {
        },
      • "state": {
        },
      }
    ],
  • "total": 19,
  • "counters": {
    }
}

Подтвердить заявку на отмену rFBS

post
/v1/conditional-cancellation/approve

Метод позволяет согласовать заявку на отмену в статусе ON_APPROVAL. Метод применим для rFBS-заказов. Заказ будет отменён, а деньги вернутся покупателю.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
cancellation_id
required
integer <int64>

Идентификатор заявки на отмену.

comment
string

Комментарий.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "cancellation_id": 74393917
}

Примеры ответа

Content type
application/json
{ }

Отклонить заявку на отмену rFBS

post
/v1/conditional-cancellation/reject

Метод позволяет отклонить заявку на отмену в статусе ON_APPROVAL. Метод применим для rFBS-заказов. Объясните своё решение в параметре comment.

Заказ останется в том же статусе, и его нужно будет доставить покупателю.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
cancellation_id
required
integer <int64>

Идентификатор заявки на отмену.

comment
string

Комментарий.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "cancellation_id": 52394916,
  • "comment": "Заявка на отмену отклоняется. Заказ будет доставлен в указанные сроки. При необходимости вы можете оформить возврат."
}

Примеры ответа

Content type
application/json
{ }

Чаты с покупателями

Отправить сообщение

post
/v1/chat/send/message

Отправляет сообщение в существующий чат по его идентификатору.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
chat_id
required
string

Идентификатор чата.

text
required
string

Текст сообщения в формате plain text от 1 до 1000 символов.

Ответы

Response Schema: application/json
result
string

Результат обработки запроса.

Примеры запроса

Content type
application/json
{
  • "chat_id": "99feb3fc-a474-469f-95d5-268b470cc607",
  • "text": "test"
}

Примеры ответа

Content type
application/json
{
  • "result": "success"
}

Отправить файл

post
/v1/chat/send/file

Отправляет файл в существующий чат по его идентификатору.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
base64_content
string

Файл в виде строки base64.

chat_id
required
string

Идентификатор чата.

name
string

Название файла с расширением.

Ответы

Response Schema: application/json
result
string

Результат обработки запроса.

Примеры запроса

Content type
application/json
{
  • "base64_content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=",
  • "chat_id": "99feb3fc-a474-469f-95d5-268b470cc607",
  • "name": "tempor"
}

Примеры ответа

Content type
application/json
{
  • "result": "success"
}

Создать новый чат

post
/v1/chat/start

Создает новый чат с покупателем по отправлению. Например, чтобы уточнить адрес или модель товара.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number
required
string

Идентификатор отправления.

Ответы

Response Schema: application/json
object

Результат работы метода.

chat_id
string

Идентификатор чата.

Примеры запроса

Content type
application/json
{
  • "posting_number": "47873153-0052-1"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Список чатов

post
/v2/chat/list

Возвращает информацию о чатах по указанным фильтрам.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Фильтр по чатам.

limit
required
integer <int64>

Количество значений в ответе. Значение по умолчанию — 30. Максимальное значение — 1000.

offset
integer <int64>

Количество элементов, которое будет пропущено в ответе. Например, если offset=10, ответ начнётся с 11-го найденного элемента.

Ответы

Response Schema: application/json
Array of objects

Данные чатов.

total_chats_count
integer <int64>

Общее количество чатов.

total_unread_count
integer <int64>

Общее количество непрочитанных сообщений.

Примеры запроса

Content type
application/json
{
  • "filter": {
    },
  • "limit": 1,
  • "offset": 0
}

Примеры ответа

Content type
application/json
{
  • "chats": [
    • {
      • "chat": {
        },
      }
    ],
  • "total_chats_count": 25,
  • "total_unread_count": 5
}

История чата

post
/v2/chat/history

Возвращает историю сообщений чата. По умолчанию от самого нового сообщения к старым.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
chat_id
required
string

Идентификатор чата.

direction
string

Направление сортировки сообщений:

  • Forward — от старых к новым.
  • Backward — от новых к старым.

Значение по умолчанию — Backward. Количество сообщений можно установить в параметре limit.

from_message_id
integer <uint64>

Идентификатор сообщения, с которого начать вывод истории чата. По умолчанию — последнее видимое сообщение.

limit
required
integer <int64>

Количество сообщений в ответе. По умолчанию — 50. Максимальное значение — 1000.

Ответы

Response Schema: application/json
has_next
boolean

Признак, что в ответе вернули не все сообщения.

Array of objects

Массив сообщений, отсортированный в соответствии с параметром direction из тела запроса.

Примеры запроса

Content type
application/json
{
  • "chat_id": "18b8e1f9-4ae7-461c-84ea-8e1f54d1a45e",
  • "direction": "Forward",
  • "from_message_id": 3000000000118032000,
  • "limit": 1
}

Примеры ответа

Content type
application/json
{
  • "has_next": true,
  • "messages": [
    • {
      • "user": {
        },
      • "data": [
        ]
      }
    ]
}

Отметить сообщения как прочитанные

post
/v2/chat/read

Метод для отметки выбранного сообщения и сообщений до него прочитанными.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
chat_id
required
string

Идентификатор чата.

from_message_id
integer <uint64>

Идентификатор сообщения.

Ответы

Response Schema: application/json
unread_count
integer <int64>

Количество непрочитанных сообщений в чате.

Примеры запроса

Content type
application/json
{
  • "chat_id": "99feb3fc-a474-469f-95d5-268b470cc607",
  • "from_message_id": 3000000000118032000
}

Примеры ответа

Content type
application/json
{
  • "unread_count": 0
}

Накладные

Создать или изменить счёт-фактуру

post
/v2/invoice/create-or-update

Создание или изменение таможенного счёта-фактуры для возврата НДС продавцам из Турции.

Request Body schema: application/json
date
required
string <date-time>

Дата счёта-фактуры.

Array of objects

HS-коды товаров.

number
string

Номер счёта-фактуры. Номер может содержать буквы и цифры, максимальная длина — 50 символов.

posting_number
required
string

Номер отправления.

price
number <double>

Стоимость, указанная в счёте-фактуре. Разделитель дробной части — точка, до двух знаков после точки.

price_currency
string

Валюта счёта-фактуры:

  • USD — доллар,
  • EUR — евро,
  • TRY — турецкая лира,
  • CNY — юань,
  • RUB — рубль,
  • GBP — фунт стерлингов.

Значение по умолчанию — USD.

url
required
string

Ссылка на счёт-фактуру. Чтобы создать ссылку, используйте метод v1/invoice/file/upload.

Ответы

Response Schema: application/json
result
boolean

Результат работы метода.

Примеры запроса

Content type
application/json
{}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Загрузка счёта-фактуры

post
/v1/invoice/file/upload

Доступные форматы: JPEG и PDF. Максимальный размер файла: 10 МБ.

Request Body schema: application/json
base64_content
required
string

Счёт-фактура в кодировке Base64.

posting_number
required
string

Номер отправления.

Ответы

Response Schema: application/json
url
string

Ссылка на счёт-фактуру.

Примеры запроса

Content type
application/json
{
  • "base64_content": "string",
  • "posting_number": "string"
}

Примеры ответа

Content type
application/json
{
  • "url": "string"
}

Получить информацию о счёте-фактуре

post
/v2/invoice/get
Request Body schema: application/json
posting_number
required
string

Номер отправления.

Ответы

Response Schema: application/json
object

Информация о счёте-фактуре.

date
string <date-time>

Дата загрузки счёта-фактуры.

file_url
string

Ссылка на счёт-фактуру.

Array of objects

HS-коды товаров.

number
string

Номер счёта-фактуры.

price
number <double>

Стоимость, указанная в счёте-фактуре. Разделитель дробной части — точка, до двух знаков после точки. Пример: 199.99.

price_currency
string

Валюта счёта-фактуры:

  • USD — доллар,
  • EUR — евро,
  • TRY — турецкая лира,
  • CNY — юань,
  • RUB — рубль,
  • GBP — фунт стерлингов.

Значение по умолчанию — USD.

Примеры запроса

Content type
application/json
{
  • "posting_number": "string"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "hs_codes": [
      • {
        }
      ],
    }
}

Удалить ссылку на счёт-фактуру

post
/v1/invoice/delete
Request Body schema: application/json
posting_number
required
string

Номер отправления.

Ответы

Response Schema: application/json
result
boolean

Результат работы метода.

Примеры запроса

Content type
application/json
{
  • "posting_number": "string"
}

Примеры ответа

Content type
application/json
{
  • "result": true
}

Отчёты

Информация об отчёте

post
/v1/report/info

Возвращает информацию о созданном ранее отчёте по его идентификатору.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
code
required
string

Уникальный идентификатор отчёта.

Ответы

Response Schema: application/json
object

Информация об отчёте.

code
string

Уникальный идентификатор отчёта.

created_at
string <date-time>

Дата создания отчёта.

error
string

Код ошибки при генерации отчёта.

file
string

Ссылка на XLSX-файл.

Для отчёта с типом SELLER_RETURNS ссылка доступна 5 минут после выполнения запроса.

object

Массив с фильтрами, указанными при создании отчёта продавцом.

report_type
string

Тип отчёта:

  • SELLER_PRODUCTS — отчёт по товарам,
  • SELLER_TRANSACTIONS — отчёт по транзакциям,
  • SELLER_PRODUCT_PRICES — отчёт по ценам товаров,
  • SELLER_STOCK — отчёт об остатках товаров,
  • SELLER_RETURNS — отчёт о возвратах,
  • SELLER_POSTINGS — отчёт об отправлениях,
  • SELLER_FINANCE — отчёт о финансах,
  • SELLER_PRODUCT_DISCOUNTED — отчёт об уценённых товарах,
  • DOCUMENT_B2B_SALES — отчёт о продажах юридическим лицам,
  • MUTUAL_SETTLEMENT — отчёт о взаиморасчётах,
  • SELLER_RETURNS_V2 — отчёт о возвратах FBO и FBS,
  • COMPENSATION — отчёт о компенсациях,
  • DECOMPENSATION — отчёт о декомпенсациях.
status
string

Статус генерации отчёта:

  • waiting — в очереди на обработку,
  • processing — обрабатывается,
  • success — отчёт успешно создан,
  • failed — ошибка при создании отчёта.

Примеры запроса

Content type
application/json
{
  • "code": "REPORT_seller_products_924336_1720170405_a9ea2f27-a473-4b13-99f9-d0cfcb5b1a69"
}

Примеры ответа

Content type
application/json
{}

Список отчётов

post
/v1/report/list

Возвращает список отчётов, которые были сформированы раньше.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
page
required
integer <int32>

Номер страницы.

page_size
required
integer <int32>

Количество значений на странице:

  • по умолчанию — 100,
  • маĸсимальное значение — 1000.
report_type
string
Default: "ALL"

Тип отчёта:

  • ALL — все отчёты,
  • SELLER_PRODUCTS — отчёт по товарам,
  • SELLER_TRANSACTIONS — отчёт по транзакциям,
  • SELLER_PRODUCT_PRICES — отчёт по ценам товаров,
  • SELLER_STOCK — отчёт об остатках товаров,
  • SELLER_RETURNS — отчёт о возвратах,
  • SELLER_POSTINGS — отчёт об отправлениях,
  • SELLER_FINANCE — отчёт о финансах,
  • SELLER_PRODUCT_DISCOUNTED — отчёт об уценённых товарах,
  • DOCUMENT_B2B_SALES — отчёт о продажах юридическим лицам,
  • MUTUAL_SETTLEMENT — отчёт о взаиморасчётах,
  • SELLER_RETURNS_V2 — отчёт о возвратах FBO и FBS,
  • COMPENSATION — отчёт о компенсациях,
  • DECOMPENSATION — отчёт о декомпенсациях.

Ответы

Response Schema: application/json
object

Результаты запроса.

Array of objects

Массив со всеми сгенерированными отчётами.

total
integer <int32>

Суммарное количество отчётов.

Примеры запроса

Content type
application/json
{
  • "page": 0,
  • "page_size": 1000,
  • "report_type": "ALL"
}

Примеры ответа

Content type
application/json
{}

Отчёт по товарам

post
/v1/report/products/create

Метод для получения отчёта с данными о товарах. Например, Ozon ID, количества товаров, цен, статуса. Соответствует разделу/действию Товары и цены → Список товаров → Скачать → Товары CSV в личном кабинете.

Пояснения к некоторым полям:

  • Ozon Product ID — идентификатор товара в нашей системе. Например, если вы продаёте товар со склада Ozon и со своего склада, Ozon Product ID будет для них одинаковым.
  • FBO Ozon SKU ID — идентификатор товара, который продаётся со склада Ozon.
  • FBS Ozon SKU ID — идентификатор товара, который продаётся с вашего склада.
  • CrossBorder Ozon SKU — идентификатор товара, который продаётся из-за границы.
  • Barcode — штрихкод товара, который печатается на маркировке.
  • Статус товара — можно ли купить товар на Ozon. Если статус «Готов к продаже», товар купить нельзя.
  • Доступно на складе Ozon, шт — сколько штук товара на складе доступно для продажи. Это количество не включает зарезервированные товары.
  • Зарезервировано, шт — сколько штук товара со статусом «Зарезервировано». Товар зарезервирован с момента получения заказа на Ozon и до упаковки для передачи покупателю.
  • Текущая цена с учётом скидки, руб. — цена, по которой товар продаётся сейчас (на момент загрузки отчёта, с учётом скидки). Если товар участвует в акции, указана цена без её учёта.
  • Базовая цена (цена до скидок), руб. — цена без учёта скидки.
  • Цена Premium, руб. — цена для покупателей с подпиской Ozon Premium.
  • Рекомендованная цена, руб. — минимальная цена на товар на другой торговой площадке.
  • Актуальная ссылка на рекомендованную цену — ссылка на товар с рекомендованной ценой на другой торговой площадке.
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
language
string
Default: "DEFAULT"

Язык ответа:

  • RU — русский,
  • EN — английский.
offer_id
Array of strings

Идентификатор товара в системе продавца — артикул.

search
string

Поиск по содержанию записи, проверяет наличие.

sku
Array of integers <int64>

Идентификатор товара в системе Ozon — SKU.

visibility
string
Default: "ALL"

Фильтр по видимости товара:

  • ALL — все товары, кроме архивных.
  • VISIBLE — товары, которые видны покупателям.
  • INVISIBLE — товары, которые не видны покупателям.
  • EMPTY_STOCK — товары, у которых не указано наличие.
  • NOT_MODERATED — товары, которые не прошли модерацию.
  • MODERATED — товары, которые прошли модерацию.
  • DISABLED — товары, которые видны покупателям, но недоступны к покупке.
  • STATE_FAILED — товары, создание которых завершилось ошибкой.
  • READY_TO_SUPPLY — товары, готовые к поставке.
  • VALIDATION_STATE_PENDING — товары, которые проходят проверку валидатором на премодерации.
  • VALIDATION_STATE_FAIL — товары, которые не прошли проверку валидатором на премодерации.
  • VALIDATION_STATE_SUCCESS — товары, которые прошли проверку валидатором на премодерации.
  • TO_SUPPLY — товары, готовые к продаже.
  • IN_SALE — товары в продаже.
  • REMOVED_FROM_SALE — товары, скрытые от покупателей.
  • BANNED — заблокированные товары.
  • OVERPRICED — товары с завышенной ценой.
  • CRITICALLY_OVERPRICED — товары со слишком завышенной ценой.
  • EMPTY_BARCODE — товары без штрихкода.
  • BARCODE_EXISTS — товары со штрихкодом.
  • QUARANTINE — товары на карантине после изменения цены более чем на 50%.

Ответы

Response Schema: application/json
object

Результаты запроса.

code
string

Уникальный идентификатор отчёта. По нему вы можете получить отчёт в течение 3 дней после запроса. Чтобы получить отчёт, передайте это значение в метод /v1/report/info.

Примеры запроса

Content type
application/json
{
  • "language": "DEFAULT",
  • "offer_id": [ ],
  • "search": "",
  • "sku": [ ],
  • "visibility": "ALL"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Отчёт о возвратах

post
/v2/report/returns/create

Метод для получения отчёта о возвратах FBO и FBS.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Фильтр.

language
string
Default: "DEFAULT"

Язык ответа:

  • RU — русский,
  • EN — английский.

Ответы

Response Schema: application/json
object

Результаты запроса.

code
string

Уникальный идентификатор отчёта. По нему вы можете получить отчёт в течение 3 дней после запроса. Чтобы получить отчёт, передайте это значение в метод /v1/report/info.

Примеры запроса

Content type
application/json
{
  • "filter": {
    },
  • "language": "DEFAULT"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Отчёт об отправлениях

post
/v1/report/postings/create

Отчёт об отправлениях с информацией по заказам:

  • статусы заказов,
  • дата начала обработки,
  • номера заказов,
  • номера отправлений,
  • стоимость отправлений,
  • содержимое отправлений. Соответствует разделу FBO → Заказы со склада Ozon и FBS → Заказы с моих складов → CSV в личном кабинете.
header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
required
object

Фильтр.

language
string
Default: "DEFAULT"

Язык ответа:

  • RU — русский,
  • EN — английский.

Ответы

Response Schema: application/json
object

Результаты запроса.

code
string

Уникальный идентификатор отчёта. По нему вы можете получить отчёт в течение 3 дней после запроса. Чтобы получить отчёт, передайте это значение в метод /v1/report/info.

Примеры запроса

Content type
application/json
{
  • "filter": {
    • "delivery_schema": [
      ],
    },
  • "language": "DEFAULT"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Финансовый отчёт

post
/v1/finance/cash-flow-statement/list

Метод для получения финансового отчёта за периоды с 01 по 15 и с 16 по 31. Запросить отчёт за отдельные дни не получится. Соответствует разделу Финансы → Список отчётов в личном кабинете.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
required
object

Период формирования отчёта.

page
required
integer <int32>

Номер страницы, возвращаемой в запросе.

with_details
boolean

true, если нужно добавить дополнительные параметры в ответ.

page_size
required
integer <int32>

Количество элементов на странице.

Ответы

Response Schema: application/json
object

Результат работы метода.

Array of objects

Список отчётов.

object

Детализированная информация.

page_count
integer <int64>

Количество страниц с отчётами.

Примеры запроса

Content type
application/json
{
  • "date": {
    },
  • "with_details": true,
  • "page": 1,
  • "page_size": 1
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "cash_flows": [
      • {
        • "period": {
          },
        }
      ],
    • "details": {
      • "period": {
        },
      • "payments": [
        • {
          }
        ],
      • "delivery": {
        • "delivery_services": {
          • "items": [
            • {
              }
            ]
          }
        },
      • "return": {
        • "return_services": {
          • "items": [
            • {
              }
            ]
          }
        },
      • "rfbs": {
        },
      • "services": {
        • "items": [
          • {
            }
          ]
        },
      • "others": {
        • "items": [
          • {
            }
          ]
        },
      }
    },
  • "page_count": 15
}

Отчёт об уценённых товарах

post
/v1/report/discounted/create

Запускает генерацию отчёта по уценённым товарам на складе Ozon. Ozon может сам уценить товар, например, при повреждении.

В результате запроса будет не сам отчёт, а его уникальный идентификатор. Чтобы получить отчёт, отправьте идентификатор в запросе метода /v1/report/info.

С одного аккаунта продавца можно отправить 1 запрос в минуту. Соответствует разделу Аналитика → Отчёты → Продажи со склада Ozon → Товары, уценённые Ozon в личном кабинете.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Ответы

Response Schema: application/json
code
string

Уникальный идентификатор отчёта. Чтобы получить отчёт, передайте это значение в метод /v1/report/info.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
application/json
{
  • "code": "REPORT_seller_products_924336_1720170405_a9ea2f27-a473-4b13-99f9-d0cfcb5b1a69"
}

Отчёт об остатках на FBS-складе

post
/v1/report/warehouse/stock

Отчёт с информацией о количестве доступных и зарезервированных единиц товара на складе. Соответствует разделу FBS → Управление логистикой → Управление остатками → Скачать в XLS в личном кабинете.

В результате запроса будет не сам отчёт, а его уникальный идентификатор. Чтобы получить отчёт, отправьте идентификатор в запросе метода /v1/report/info.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
language
string
Default: "DEFAULT"

Язык ответа:

  • RU — русский,
  • EN — английский.
warehouseId
required
Array of strings <int64>

Идентификаторы складов.

Ответы

Response Schema: application/json
object

Результаты запроса.

code
string

Уникальный идентификатор отчёта. По нему вы можете получить отчёт в течение 3 дней после запроса. Чтобы получить отчёт, передайте это значение в метод /v1/report/info.

Примеры запроса

Content type
application/json
{
  • "language": "DEFAULT",
  • "warehouseId": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "code": "REPORT_seller_products_924336_1720170405_a9ea2f27-a473-4b13-99f9-d0cfcb5b1a69"
}

Аналитические отчёты

Данные аналитики

post
/v1/analytics/data

Уĸажите период и метриĸи, ĸоторые нужно посчитать. В ответе будет аналитиĸа, сгруппированная по параметру dimensions.

Для продавцов без Premium-подписки:

  • доступны данные за последние 3 месяца,
  • есть ограничения по способам группировки данных и метрикам.

Для продавцов с Premium-подпиской ограничений нет.

Метод можно использовать не больше 1 раза в минуту. Соответствует разделу Аналитика → Графики в личном кабинете.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
date_from
required
string

Дата, с которой будут данные в отчёте.

Если у вас нет Premium-подписки, укажите дату в пределах последних трёх месяцев.

date_to
required
string

Дата, по которую будут данные в отчёте.

dimension
required
Array of strings

Группировка данных в отчёте.

Способы группировки, доступные всем продавцам:

  • unknownDimension — неизвестное измерение,
  • sku — идентификатор товара,
  • spu — идентификатор товара,
  • day — день,
  • week — неделя,
  • month — месяц.

Способы группировки, доступные только продавцам с Premium-подпиской:

  • year — год,
  • category1 — категория первого уровня,
  • category2 — категория второго уровня,
  • category3 — категория третьего уровня,
  • category4 — категория четвертого уровня,
  • brand — бренд,
  • modelID — модель.
Array of objects

Фильтры.

limit
required
integer <int64>

Количество значений в ответе:

  • максимум — 1000,
  • минимум — 1.
metrics
required
Array of strings

Укажите до 14 метрик. Если их будет больше, вы получите ошибку с кодом InvalidArgument.

Список метриĸ, по ĸоторым будет сформирован отчёт.

Метрики, доступные всем продавцам:

  • revenue — заказано на сумму,
  • ordered_units — заказано товаров.

Метрики, доступные только продавцам с Premium-подпиской:

  • unknown_metric — неизвестная метрика.
  • hits_view_search — показы в поиске и в категории.
  • hits_view_pdp — показы на карточке товара.
  • hits_view — всего показов.
  • hits_tocart_search — в корзину из поиска или категории.
  • hits_tocart_pdp — в корзину из карточки товара.
  • hits_tocart — всего добавлено в корзину.
  • session_view_search — сессии с показом в поиске или в каталоге. Считаются уникальные посетители с просмотром в поиске или каталоге.
  • session_view_pdp — сессии с показом на карточке товара. Считаются уникальные посетители, которые просмотрели карточку товара.
  • session_view — всего сессий. Считаются уникальные посетители.
  • conv_tocart_search — конверсия в корзину из поиска или категории.
  • conv_tocart_pdp — конверсия в корзину из карточки товара.
  • conv_tocart — общая конверсия в корзину.
  • returns — возвращено товаров.
  • cancellations — отменено товаров.
  • delivered_units — доставлено товаров.
  • position_category — позиция в поиске и категории.
offset
integer <int64>

Количество элементов, которое будет пропущено в ответе. Например, если offset = 10, то ответ начнётся с 11-го найденного элемента.

Array of objects

Настройки сортировки отчёта.

Ответы

Response Schema: application/json
object

Результаты запроса.

Array of objects

Массив данных.

totals
Array of numbers <double>

Итоговые и средние значения метрик.

timestamp
string

Время создания отчёта.

Примеры запроса

Content type
application/json
{
  • "date_from": "2020-09-01",
  • "date_to": "2021-10-15",
  • "metrics": [
    ],
  • "dimension": [
    ],
  • "filters": [ ],
  • "sort": [
    • {
      }
    ],
  • "limit": 1000,
  • "offset": 0
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "totals": [
      ]
    },
  • "timestamp": "2021-11-25 15:19:21"
}

Отчёт по остаткам и товарам

post
/v2/analytics/stock_on_warehouses

Метод для получения отчёта по остаткам и товарам в перемещении по складам Ozon.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
limit
required
integer <int64>

Количество ответов на странице. По умолчанию — 100.

offset
integer <int64>

Количество элементов, которое будет пропущено в ответе. Например, если offset = 10, то ответ начнётся с 11-го найденного элемента.

warehouse_type
string
Default: "ALL"
Enum: "ALL" "EXPRESS_DARK_STORE" "NOT_EXPRESS_DARK_STORE"

Фильтр по типу склада:

  • EXPRESS_DARK_STORE — склады Ozon с доставкой Fresh.
  • NOT_EXPRESS_DARK_STORE — склады Ozon без доставки Fresh.
  • ALL — все склады Ozon.

Ответы

Response Schema: application/json
object

Результат запроса.

Array of objects

Информация о товарах и остатках.

Примеры запроса

Content type
application/json
{
  • "limit": 1000,
  • "offset": 0,
  • "warehouse_type": "ALL"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "rows": [
      • {
        }
      ]
    }
}

Оборачиваемость товара

post
/v1/analytics/turnover/stocks

Используйте метод, чтобы узнать оборачиваемость товара и количество дней, на которое хватит текущего остатка. Метод соответствует разделу FBO -> Управление остатками в личном кабинете. Вы можете делать не больше 1 запроса в минуту по одному кабинету Client-Id.

Если вы запрашиваете список товаров по sku, параметры limit и offset необязательны.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
limit
integer <int32> [ 1 .. 1000 ]

Количество значений в ответе.

offset
integer <int32>

Количество элементов, которое будет пропущено в ответе.

Например, если offset = 10, ответ начнётся с 11-го найденного элемента.

sku
Array of strings <int64>

Идентификаторы товаров в системе Ozon — SKU.

Ответы

Response Schema: application/json
Array of objects

Товары.

Array ()
ads
number <double>

Среднесуточное количество проданных единиц товара за последние 60 дней.

current_stock
integer <int64>

Остаток товара, шт.

idc
number <double>

На сколько дней хватит остатка товара с учётом среднесуточных продаж.

idc_grade
string
Default: "GRADES_NONE"
Enum: "GRADES_NONE" "GRADES_NOSALES" "GRADES_GREEN" "GRADES_YELLOW" "GRADES_RED" "GRADES_CRITICAL"

Уровень остатка товара:

  • GRADES_NONE — ожидаются поставки;
  • GRADES_NOSALES — нет продаж;
  • GRADES_GREEN — зелёный, «хороший»;
  • GRADES_YELLOW — жёлтый, «средний»;
  • GRADES_RED — красный, «плохой»;
  • GRADES_CRITICAL — критический.
name
string

Название товара.

offer_id
string

Идентификатор товара в системе продавца — артикул.

sku
integer <int64>

Идентификатор товара в системе Ozon — SKU.

turnover
number <double>

Фактическая оборачиваемость в днях.

turnover_grade
string
Default: "GRADES_NONE"
Enum: "GRADES_NONE" "GRADES_NOSALES" "GRADES_GREEN" "GRADES_YELLOW" "GRADES_RED" "GRADES_CRITICAL"

Уровень оборачиваемости:

  • GRADES_NONE — ожидаются поставки;
  • GRADES_NOSALES — нет продаж;
  • GRADES_GREEN — зелёный, «хороший»;
  • GRADES_YELLOW — жёлтый, «средний»;
  • GRADES_RED — красный, «плохой»;
  • GRADES_CRITICAL — критический.

Примеры запроса

Content type
application/json
{
  • "limit": 1,
  • "offset": 0,
  • "sku": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "items": [
    • {
      }
    ]
}

Финансовые отчёты

Отчёт о реализации товаров (версия 2)

post
/v2/finance/realization

Отчёт о реализации доставленных и возвращённых товаров за месяц. Отмены и невыкупы не включаются. Соответствует разделу Финансы → Документы → Отчёты о реализации → Отчёт о реализации товара в личном кабинете.

Отчёт придёт не позднее 5-го числа следующего месяца.

Подробнее об отчёте в Базе знаний продавца

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
month
required
integer <int32>

Месяц.

year
required
integer <int32>

Год.

Ответы

Response Schema: application/json
object

Результат запроса.

object

Титульный лист отчёта.

Array of objects

Таблица отчёта.

Примеры запроса

Content type
application/json
{
  • "month": 0,
  • "year": 0
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "header": {
      },
    • "rows": [
      • {
        • "delivery_commission": {
          },
        • "item": {
          },
        • "return_commission": {
          },
        }
      ]
    }
}

Список транзакций

post
/v3/finance/transaction/list

Возвращает подробную информацию по всем начислениям. Максимальный период, за который можно получить информацию в одном запросе — 1 месяц.

Если в запросе не указывать posting_number, то в ответе будут все отправления за указанный период или отправления определённого типа. Соответствует разделу Финансы → Начисления в личном кабинете.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
posting_number (object) or date (object)

Фильтр.

page
required
integer <int64>

Номер страницы, возвращаемой в запросе.

page_size
required
integer <int64>

Количество элементов на странице.

Ответы

Response Schema: application/json
object

Результаты запроса.

Array of objects

Информация об операциях.

page_count
integer <int64>

Количество страниц. Если 0, страниц больше нет.

row_count
integer <int64>

Количество транзакций на всех страницах. Если 0, транзакций больше нет.

Примеры запроса

Content type
application/json
{
  • "filter": {
    • "date": {
      },
    },
  • "page": 1,
  • "page_size": 1000
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "operations": [
      • {
        • "posting": {
          },
        }
      ],
    }
}

Суммы транзакций

post
/v3/finance/transaction/totals

Возвращает итоговые суммы по транзакциям за указанный период. Соответствует разделу Финансы → Начисления → Баннер с общими суммами в личном кабинете.

Если вы неправильно заполните номера отправлений, в ответе вернутся нулевые значения.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
One of
object

Фильтр по дате.

posting_number
required
string

Номер отправления.

transaction_type
string

Тип операции:

  • all — все,
  • orders — заказы,
  • returns — возвраты и отмены,
  • services — сервисные сборы,
  • compensation — компенсация,
  • transferDelivery — стоимость доставки,
  • other — прочее.

Ответы

Response Schema: application/json
object

Результаты запроса.

accruals_for_sale
number <double>

Общая стоимость товаров и возвратов в заданный период.

compensation_amount
number <double>

Компенсации.

money_transfer
number <double>

Начисления за доставку и возвраты при работе по схеме «Доставка по выбору продавца».

others_amount
number <double>

Прочие начисления.

processing_and_delivery
number <double>

Стоимость услуг обработки отправлений, сборки заказов, магистрали и последней мили, а также доставки до введения новых комиссий и тарифов с 1 февраля 2021 года.

Магистраль — доставка товаров между кластерами.

Последняя миля — доставка товаров покупателю в пункт выдачи заказов, постамат или курьером.

refunds_and_cancellations
number <double>

Стоимость обратной магистрали, обработки возвратов, отмен и невыкупа товара, а также возвратов до введения новых комиссий и тарифов с 1 февраля 2021 года.

Магистраль — доставка товаров между кластерами.

Последняя миля — доставка товаров покупателю в пункт выдачи заказов, постамат или курьером.

sale_commission
number <double>

Сумма комиссии, которая была удержана при продаже товара и возвращена при его возврате.

services_amount
number <double>

Стоимость дополнительных услуг, не связанных напрямую с доставками и возвратами товаров. Например, продвижения или размещения товаров.

Примеры запроса

Content type
application/json
{
  • "date": {
    },
  • "posting_number": "",
  • "transaction_type": "all"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Реестр продаж юридическим лицам

post
/v1/finance/document-b2b-sales

Используйте метод, чтобы получить отчёт по продажам юридическим лицам. Соответствует разделу Финансы → Документы → Реестр продаж юр. лицам в личном кабинете.

Request Body schema: application/json
date
string

Отчётный период в формате YYYY-MM.

language
string
Default: "DEFAULT"

Язык ответа:

  • RU — русский,
  • EN — английский.

Ответы

Response Schema: application/json
object

Результаты запроса.

code
string

Уникальный идентификатор отчёта. По нему вы можете получить отчёт в течение 3 дней после запроса. Чтобы получить отчёт, передайте это значение в метод /v1/report/info.

Примеры запроса

Content type
application/json
{
  • "date": "string",
  • "language": "DEFAULT"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Отчёт о взаиморасчётах

post
/v1/finance/mutual-settlement

Используйте метод, чтобы получить отчёт о взаиморасчетах. Соответствует разделу Финансы → Документы → Аналитические отчеты → Отчет о взаиморасчетах в личном кабинете.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
date
string

Отчётный период в формате YYYY-MM.

language
string
Default: "DEFAULT"

Язык ответа:

  • RU — русский,
  • EN — английский.

Ответы

Response Schema: application/json
object

Результаты запроса.

code
string

Уникальный идентификатор отчёта. По нему вы можете получить отчёт в течение 3 дней после запроса. Чтобы получить отчёт, передайте это значение в метод /v1/report/info.

Примеры запроса

Content type
application/json
{
  • "date": "string",
  • "language": "DEFAULT"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Рейтинг продавца

Работая с Ozon, продавцы должны соблюдать требования по качеству обслуживания, срокам доставки и общению с клиентами. Система рейтингов отражает качество сервиса продавца, а некоторые показатели видны покупателям — это рейтинг товаров и индекс цен.

Подробнее о системе рейтингов в Базе знаний продавца

Получить информацию о текущих рейтингах продавца

post
/v1/rating/summary

Рейтинг продавца по следующим показателям: индекс цен, доставки вовремя, процент отмен, жалобы и другие. Соответствует разделу Рейтинги → Рейтинги продавца в личном кабинете.

Request Body schema: application/json
object

Ответы

Response Schema: application/json
Array of objects

Список с группами рейтингов.

Array of objects

Данные по индексу локализации. Если за последние 14 дней у вас не было продаж, поля параметра будут пустыми.

penalty_score_exceeded
boolean

Признак, что баланс штрафных баллов превышен.

premium
boolean

Признак наличия подписки Premium.

premium_plus
boolean

Признак наличия подписки Premium Plus.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
application/json
{
  • "groups": [
    • {
      • "items": [
        • {
          • "change": {
            },
          }
        ]
      }
    ],
  • "localization_index": [
    • {
      }
    ],
  • "penalty_score_exceeded": true,
  • "premium": true,
  • "premium_plus": true
}

Получить информацию о рейтингах продавца за период

post
/v1/rating/history

Информация о рейтингах за заданный период и с фильтром по нужному рейтингу. Соответствует разделу Рейтинги → Рейтинги продавца в личном кабинете.

Request Body schema: application/json
date_from
required
string <date-time>

Начало периода.

date_to
required
string <date-time>

Конец периода.

ratings
required
Array of strings

Фильтр по рейтингу.

Рейтинги, по которым нужно получить значение за период:

  • rating_on_time — процент заказов, выполненных вовремя за последние 30 дней.
  • rating_review_avg_score_total — средняя оценка всех товаров.
  • rating_price — индекс цен: отношение стоимости ваших товаров к самой низкой цене на такой же товар на других площадках.
  • rating_order_cancellation — процент отмен FBS-отправлений по вашей вине за последние 7 дней. Текущий и предыдущий день не учитываются.
  • rating_shipment_delay — процент FBS-отправлений, которые за последние 7 дней не были переданы в доставку по вашей вине. Текущий и предыдущий день не учитываются.
  • rating_ssl — оценка работы по FBO. Учитывает rating_on_time_supply_delivery, rating_on_time_supply_cancellation и rating_order_accuracy.
  • rating_on_time_supply_delivery — процент поставок, которые вы привезли на склад в выбранный временной интервал за последние 60 дней.
  • rating_order_accuracy — процент поставок без излишков, недостач, пересорта и брака за последние 60 дней.
  • rating_on_time_supply_cancellation — процент заявок на поставку, которые завершились или были отменены без опоздания за последние 60 дней.
  • rating_reaction_time — время, в течение которого покупатели в среднем ждали ответа на своё первое сообщение в чате за последние 30 дней.
  • rating_average_response_time — время, в течение которого покупатели в среднем ждали вашего ответа за последние 30 дней.
  • rating_replied_dialogs_ratio — доля диалогов хотя бы с одним вашим ответом в течение 24 часов за последние 30 дней.

Если вы хотите получить информацию по начисленным штрафным баллам для рейтингов rating_on_time и rating_review_avg_score_total, передайте значения нужных рейтингов в этом параметре и with_premium_scores=true.

with_premium_scores
boolean

Признак, что в ответе нужно вернуть информацию о штрафных баллах в Premium-программе.

Ответы

Response Schema: application/json
Array of objects

Информация о штрафных баллах в Premium-программе.

Array of objects

Информация о рейтингах продавца.

Примеры запроса

Content type
application/json
{
  • "date_from": "2019-08-24T14:15:22Z",
  • "date_to": "2019-08-24T14:15:22Z",
  • "ratings": [
    ],
  • "with_premium_scores": true
}

Примеры ответа

Content type
application/json
{
  • "premium_scores": [
    • {
      • "scores": [
        • {
          }
        ]
      }
    ],
  • "ratings": [
    • {
      • "values": [
        • {
          • "status": {
            },
          }
        ],
      }
    ]
}

Бета-методы Seller API

Бета-методы Seller API — раздел с методами, которые находятся на стадии тестирования. Такие методы могут работать нестабильно, а их запросы и ответы могут меняться. Об изменениях в работе бета-методов уведомляем за неделю в сообществе разработчиков Ozon for dev. В сообществе вы также можете оставить обратную связь по работе бета-методов и предложить свои идеи.

Бета-методы доступны по API-ключам в зависимости от вашей роли.

Прочие методы

Управление остатками

post
/v1/analytics/manage/stocks

Используйте метод, чтобы узнать, сколько товаров осталось на складах FBO.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Фильтр.

limit
integer <int32> [ 1 .. 1000 ]

Количество значений в ответе.

offset
integer <int32>

Количество элементов, которое будет пропущено в ответе.

Например, если offset = 10, ответ начнётся с 11-го найденного элемента.

Ответы

Response Schema: application/json
Array of objects

Товары.

Array ()
defect_stock_count
integer <int64>

Остаток дефектного товара, шт.

expiring_stock_count
integer <int64>

Остаток товара с истекающим сроком годности, шт.

name
string

Название товара.

offer_id
string

Идентификатор товара в системе продавца — артикул.

sku
integer <int64>

Идентификатор товара в системе Ozon — SKU.

valid_stock_count
integer <int64>

Остаток товара, доступного для продажи.

waitingdocs_stock_count
integer <int64>

Остаток товара, ожидающего документы.

warehouse_name
string

Название склада.

Примеры запроса

Content type
application/json
{
  • "filter": {
    • "skus": [
      ],
    • "stock_types": [
      ],
    • "warehouse_ids": [
      ]
    },
  • "limit": 1,
  • "offset": 0
}

Примеры ответа

Content type
application/json
{
  • "items": [
    • {
      }
    ]
}

Получить информацию о запросах моих товаров

post
/v1/analytics/product-queries

Используйте метод, чтобы получить данные о запросах ваших товаров. Полная аналитика доступна с подпиской Premium или Premium Plus. Без подписки вы можете посмотреть часть показателей. Метод аналогичен вкладке Товары в поиске → Запросы моего товара в личном кабинете.

Аналитику по запросам можно проверить за определённые даты. Для этого укажите интервал в полях date_from и date_to. Данные за последний месяц доступны в любом интервале, кроме трёх дней от текущей даты — в эти дни происходит расчёт. Аналитика за даты позже, чем месяц назад, доступна только с подпиской Premium или Premium Plus и только по неделям — в запросе укажите параметр date_from.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
date_from
required
string <date-time>

Дата начала формирования аналитики.

date_to
string <date-time>

Дата окончания формирования аналитики.

page
integer <int32>

Номер страницы, возвращаемой в запросе.

page_size
required
integer <int32>

Количество элементов на странице.

skus
required
Array of strings <int64>

Список SKU, идентификаторов товара в системе Ozon. По ним вернётся аналитика по запросам. Максимум — 1000 SKU.

sort_by
string
Default: "BY_SEARCHES"
Enum: "BY_SEARCHES" "BY_VIEWS" "BY_POSITION" "BY_CONVERSION" "BY_GMV"

Параметр, по которому товары будут отсортированы. Возможные значения:

  • BY_SEARCHES — по количеству запросов;
  • BY_VIEWS — по количеству просмотров;
  • BY_POSITION — по средней позиции товара;
  • BY_CONVERSION — по значению конверсии;
  • BY_GMV — по объёму продаж по запросам.
sort_dir
string
Default: "DESCENDING"
Enum: "DESCENDING" "ASCENDING"

Направление сортировки:

  • DESCENDING — по убыванию;
  • ASCENDING — по возрастанию.

Ответы

Response Schema: application/json
object

Период, за который формируется аналитика.

Array of objects

Список товаров.

page_count
integer <int64>

Количество страниц.

total
integer <int64>

Общее количество запросов.

Примеры запроса

Content type
application/json
{
  • "date_from": "2019-08-24T14:15:22Z",
  • "date_to": "2019-08-24T14:15:22Z",
  • "page": 0,
  • "page_size": 0,
  • "skus": [
    ],
  • "sort_by": "BY_SEARCHES",
  • "sort_dir": "DESCENDING"
}

Примеры ответа

Content type
application/json
{
  • "analytics_period": {
    },
  • "items": [
    • {
      }
    ],
  • "page_count": 0,
  • "total": 0
}

Получить детализацию запросов по товару

post
/v1/analytics/product-queries/details

Используйте метод, чтобы получить данные по запросам на конкретный товар. Полная аналитика доступна с подпиской Premium или Premium Plus. Без подписки вы можете посмотреть часть показателей. Метод аналогичен просмотру данных по товару на вкладке Товары в поиске → Запросы моего товара в личном кабинете.

Аналитику по запросам можно проверить за определённые даты. Для этого укажите интервал в полях date_from и date_to. Данные за последний месяц доступны в любом интервале, кроме трёх дней от текущей даты — в эти дни происходит расчёт. Аналитика за даты позже, чем месяц назад, доступна только с подпиской Premium или Premium Plus и только по неделям — в запросе укажите параметр date_from.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
date_from
required
string <date-time>

Дата начала формирования аналитики.

date_to
string <date-time>

Дата окончания формирования аналитики.

limit_by_sku
required
integer <int32>

Лимит числа запросов по одному SKU. Максимум — 15 запросов.

page
integer <int32>

Номер страницы, возвращаемой в запросе. Минимум — 0.

page_size
required
integer <int32>

Количество элементов на странице. Максимум — 100.

skus
required
Array of strings <int64>

Список SKU, идентификаторов товара в системе Ozon. По ним вернётся аналитика по запросам. Максимум — 1000 SKU.

sort_by
string
Default: "BY_SEARCHES"
Enum: "BY_SEARCHES" "BY_VIEWS" "BY_POSITION" "BY_CONVERSION" "BY_GMV"

Параметр, по которому товары будут отсортированы. Возможные значения:

  • BY_SEARCHES — по количеству запросов;
  • BY_VIEWS — по количеству просмотров;
  • BY_POSITION — по средней позиции товара;
  • BY_CONVERSION — по значению конверсии;
  • BY_GMV — по объёму продаж по запросам.

Сортировка по параметрам BY_VIEWS, BY_POSITION и BY_CONVERSION доступна только с подпиской Premium или Premium Plus.

sort_dir
string
Default: "DESCENDING"
Enum: "DESCENDING" "ASCENDING"

Направление сортировки:

  • DESCENDING — по убыванию;
  • ASCENDING — по возрастанию.

Ответы

Response Schema: application/json
object

Период, за который формируется аналитика.

page_count
integer <int64>

Количество страниц.

Array of objects

Список запросов.

total
integer <int64>

Общее количество запросов.

Примеры запроса

Content type
application/json
{
  • "date_from": "2019-08-24T14:15:22Z",
  • "date_to": "2019-08-24T14:15:22Z",
  • "limit_by_sku": 0,
  • "page": 0,
  • "page_size": 0,
  • "skus": [
    ],
  • "sort_by": "BY_SEARCHES",
  • "sort_dir": "DESCENDING"
}

Примеры ответа

Content type
application/json
{
  • "analytics_period": {
    },
  • "page_count": 0,
  • "queries": [
    • {
      }
    ],
  • "total": 0
}

Получить аналитику по остаткам

post
/v1/analytics/stocks

Используйте метод, чтобы получить аналитику по остаткам товаров на складах. Метод соответствует разделу FBO → Управление остатками в личном кабинете. Аналитика обновляется раз в день в 05:00 UTC.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
cluster_ids
Array of strings <int64>

Фильтр по идентификаторам кластеров. Получить идентификаторы можно через метод /v1/cluster/list.

item_tags
Array of strings
Items Enum: "ITEM_ATTRIBUTE_NONE" "ECONOM" "NOVEL" "DISCOUNT" "FBS_RETURN" "SUPER"

Фильтр по тегам товара:

  • ITEM_ATTRIBUTE_NONE — без тега;
  • ECONOM — эконом-товар;
  • NOVEL — новинка;
  • DISCOUNT — уценённый товар;
  • FBS_RETURN — товар из возврата FBS;
  • SUPER — Super-товар.
skus
required
Array of strings <int64> <= 100

Фильтр по идентификаторам товаров в системе Ozon — SKU.

turnover_grades
Array of strings
Items Enum: "TURNOVER_GRADE_NONE" "DEFICIT" "POPULAR" "ACTUAL" "SURPLUS" "WAS_NO_SALES" "COLLECTING_DATA" "WAITING_FOR_SUPPLY" "WAS_DEFICIT" "WAS_POPULAR" "WAS_ACTUAL" "WAS_SURPLUS"

Фильтр по статусу ликвидности товаров:

  • TURNOVER_GRADE_NONE — нет статуса ликвидности.
  • DEFICIT — дефицитный. Остатков товара хватит до 28 дней.
  • POPULAR — очень популярный. Остатков товара хватит на 28–56 дней.
  • ACTUAL — популярный. Остатков товара хватит на 56–120 дней.
  • SURPLUS — избыточный. Товар продаётся медленно, остатков хватит более чем на 120 дней.
  • WAS_NO_SALES — без продаж. У товара не было продаж последние 28 дней.
  • COLLECTING_DATA — сбор данных. Для расчёта ликвидности нового товара собираем данные в течение 60 дней после поставки.
  • WAITING_FOR_SUPPLY — ожидаем поставки. На складе нет остатков, доступных к продаже. Сделайте поставку для начала сбора данных.
  • WAS_DEFICIT — был дефицитным. Товар был дефицитным последние 56 дней. Сейчас у него нет остатков.
  • WAS_POPULAR — был очень популярным. Товар был очень популярным последние 56 дней. Сейчас у него нет остатков.
  • WAS_ACTUAL — был популярным. Товар был популярным последние 56 дней. Сейчас у него нет остатков.
  • WAS_SURPLUS — был избыточным. Товар был избыточным последние 56 дней. Сейчас у него нет остатков.
warehouse_ids
Array of strings <int64>

Фильтр по идентификаторам складов. Получить идентификаторы можно через метод /v1/warehouse/list.

Ответы

Response Schema: application/json
Array of objects

Информация о товарах.

Array ()
ads
number <double>

Среднесуточное количество проданных единиц товара за последние 28 дней.

available_stock_count
integer <int32>

Количество единиц товара, доступное к продаже.

cluster_id
integer <int64>

Идентификатор кластера. Получить подробную информацию о кластере можно через метод /v1/cluster/list.

cluster_name
string

Название кластера.

days_without_sales
integer <int32>

Количество дней без продаж.

excess_stock_count
integer <int32>

Количество излишков с поставки, которые доступны к вывозу.

expiring_stock_count
integer <int32>

Количество единиц товара с истекающим сроком годности.

idc
number <double>

Количество дней, на которое хватит остатка товара с учётом среднесуточных продаж за 28 дней.

item_tags
Array of strings
Items Enum: "ITEM_ATTRIBUTE_NONE" "ECONOM" "NOVEL" "DISCOUNT" "FBS_RETURN" "SUPER"

Теги товара:

  • ITEM_ATTRIBUTE_NONE — без тега;
  • ECONOM — эконом-товар;
  • NOVEL — новинка;
  • DISCOUNT — уценённый товар;
  • FBS_RETURN — товар из возврата FBS;
  • SUPER — Super-товар.
name
string

Название товара.

offer_id
string

Идентификатор товара в системе продавца — артикул.

other_stock_count
integer <int32>

Количество единиц товара, проходящих проверку.

requested_stock_count
integer <int32>

Количество единиц товара в заявках на поставку.

return_from_customer_stock_count
integer <int32>

Количество единиц товара в процессе возврата от покупателей.

return_to_seller_stock_count
integer <int32>

Количество единиц товара, готовящихся к вывозу по вашей заявке.

sku
integer <int64>

Идентификатор товара в системе Ozon — SKU.

stock_defect_stock_count
integer <int32>

Количество брака, доступное к вывозу со стока.

transit_defect_stock_count
integer <int32>

Количество брака, доступное к вывозу с поставки.

transit_stock_count
integer <int32>

Количество единиц товара в поставках в пути.

turnover_grade
string
Enum: "TURNOVER_GRADE_NONE" "DEFICIT" "POPULAR" "ACTUAL" "SURPLUS" "WAS_NO_SALES" "COLLECTING_DATA" "WAITING_FOR_SUPPLY" "WAS_DEFICIT" "WAS_POPULAR" "WAS_ACTUAL" "WAS_SURPLUS"

Статус ликвидности товара:

  • TURNOVER_GRADE_NONE — нет статуса ликвидности.
  • DEFICIT — дефицитный. Остатков товара хватит до 28 дней.
  • POPULAR — очень популярный. Остатков товара хватит на 28–56 дней.
  • ACTUAL — популярный. Остатков товара хватит на 56–120 дней.
  • SURPLUS — избыточный. Товар продаётся медленно, остатков хватит более чем на 120 дней.
  • WAS_NO_SALES — без продаж. У товара не было продаж последние 28 дней.
  • COLLECTING_DATA — сбор данных. Для расчёта ликвидности нового товара собираем данные в течение 60 дней после поставки.
  • WAITING_FOR_SUPPLY — ожидаем поставки. На складе нет остатков, доступных к продаже. Сделайте поставку для начала сбора данных.
  • WAS_DEFICIT — был дефицитным. Товар был дефицитным последние 56 дней. Сейчас у него нет остатков.
  • WAS_POPULAR — был очень популярным. Товар был очень популярным последние 56 дней. Сейчас у него нет остатков.
  • WAS_ACTUAL — был популярным. Товар был популярным последние 56 дней. Сейчас у него нет остатков.
  • WAS_SURPLUS — был избыточным. Товар был избыточным последние 56 дней. Сейчас у него нет остатков.
valid_stock_count
integer <int32>

Количество единиц товара, доступное для продажи.

waiting_docs_stock_count
integer <int32>

Количество маркируемых товаров, которые ожидают ваших действий.

warehouse_id
integer <int64>

Идентификатор склада.

warehouse_name
string

Название склада.

Примеры запроса

Content type
application/json
{
  • "cluster_ids": [
    ],
  • "item_tags": [
    ],
  • "skus": [
    ],
  • "turnover_grades": [
    ],
  • "warehouse_ids": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "items": [
    • {
      • "item_tags": [
        ],
      }
    ]
}

Изменение состава отгрузки

post
/v1/carriage/set-postings

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
carriage_id
integer <int64>

Идентификатор отгрузки.

posting_numbers
Array of strings

Актуальный список отправлений.

Ответы

Response Schema: application/json
Array of objects
Array ()
error
string

Описание ошибки.

posting_number
string

Номер отправления.

result
boolean

Результат обработки запроса. true, если запрос был обработан успешно.

Примеры запроса

Content type
application/json
{
  • "carriage_id": 0,
  • "posting_numbers": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      }
    ]
}

Удаление отгрузки

post
/v1/carriage/cancel

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
carriage_id
integer <int64>

Идентификатор отгрузки.

Ответы

Response Schema: application/json
error
string

Описание ошибки.

carriage_status
string

Статус отгрузки.

Примеры запроса

Content type
application/json
{
  • "carriage_id": 0
}

Примеры ответа

Content type
application/json
{
  • "error": "string",
  • "carriage_status": "string"
}

Отчёт о реализации товаров за день

post
/v1/finance/realization/by-day

Метод возвращает данные о суммах реализации из отчёта о реализации товаров за день. Отмены и невыкупы не включаются. Данные доступны не более чем за 32 календарных дня от текущей даты. Метод доступен только с подпиской Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
day
required
integer <int32>

День.

month
required
integer <int32>

Месяц.

year
required
integer <int32>

Год.

Ответы

Response Schema: application/json
Array of objects

Таблица отчёта.

Array ()
commission_ratio
number <double>

Доля комиссии за продажу по категории.

object

Комиссия за доставку.

object

Информация о товаре.

object

Комиссия за возврат товара.

rowNumber
integer <int32>

Номер строки в отчёте.

seller_price_per_instance
number <double>

Цена продавца с учётом скидки.

Примеры запроса

Content type
application/json
{
  • "day": 0,
  • "month": 0,
  • "year": 0
}

Примеры ответа

Content type
application/json
{
  • "rows": [
    • {
      • "delivery_commission": {
        },
      • "item": {
        },
      • "return_commission": {
        },
      }
    ]
}

Позаказный отчёт о реализации товаров

post
/v1/finance/realization/posting

Отчёт о реализации доставленных и возвращённых товаров с детализацией по каждому заказу. Отмены и невыкупы не включаются. Отчёт доступен с настоящего времени по август 2023 года включительно.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
month
required
integer <int32>

Месяц.

year
required
integer <int32>

Год.

Ответы

Response Schema: application/json
object

Титульный лист отчёта.

Array of objects

Таблица отчёта.

Примеры запроса

Content type
application/json
{
  • "month": 2,
  • "year": 2025
}

Примеры ответа

Content type
application/json
{
  • "header": {
    },
  • "rows": [
    • {
      • "delivery_commission": {
        },
      • "item": {
        },
      • "return_commission": {
        },
      • "order": {
        },
      • "legal_entity_document": {
        }
      }
    ]
}

Отчёт о компенсациях

post
/v1/finance/compensation

Метод для получения отчёта о компенсациях. Соответствует отчёту из раздела Финансы → Документы → Компенсации и прочие начисления в личном кабинете.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

Request Body schema: application/json
date
required
string

Отчётный период в формате YYYY-MM.

language
string
Default: "RU"

Язык отчёта:

  • RU — русский,
  • EN — английский.

Ответы

Response Schema: application/json
object

Результат запроса.

code
string

Уникальный идентификатор отчёта. Чтобы получить отчёт, передайте это значение в метод /v1/report/info.

Примеры запроса

Content type
application/json
{
  • "date": "2023-09",
  • "language": "RU"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Отчёт о декомпенсациях

post
/v1/finance/decompensation

Метод для получения отчёта о декомпенсациях. Соответствует отчёту из раздела Финансы → Документы → Компенсации и прочие начисления в личном кабинете.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

Request Body schema: application/json
date
required
string

Отчётный период в формате YYYY-MM.

language
string
Default: "RU"

Язык отчёта:

  • RU — русский,
  • EN — английский.

Ответы

Response Schema: application/json
object

Результат запроса.

code
string

Уникальный идентификатор отчёта. Чтобы получить отчёт, передайте это значение в метод /v1/report/info.

Примеры запроса

Content type
application/json
{
  • "date": "2023-09",
  • "language": "RU"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    }
}

Обновление таймера актуальности минимальной цены

post
/v1/product/action/timer/update

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
product_ids
Array of strings <int64>

Список идентификаторов товаров в системе продавца — product_id.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "product_ids": [
    ]
}

Примеры ответа

Content type
application/json
{ }

Получить статус установленного таймера

post
/v1/product/action/timer/status

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
product_ids
Array of strings <int64>

Список идентификаторов товаров в системе продавца — product_id.

Ответы

Response Schema: application/json
Array of objects
Array ()
expired_at
string <date-time>

Время окончания таймера.

min_price_for_auto_actions_enabled
boolean

true, если Ozon учитывает минимальную цену при добавлении в акции.

product_id
integer <int64>

Идентификатор товара в системе продавца — product_id.

Примеры запроса

Content type
application/json
{
  • "product_ids": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "statuses": [
    • {
      }
    ]
}

История чата

post
/v3/chat/history

Возвращает историю сообщений чата. По умолчанию от самого нового сообщения к старым.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
chat_id
required
string

Идентификатор чата.

direction
string

Направление сортировки сообщений:

  • Forward — от старых к новым.
  • Backward — от новых к старым.

Значение по умолчанию — Backward. Количество сообщений можно установить в параметре limit.

object

Фильтр по сообщениям.

from_message_id
integer <uint64>

Идентификатор сообщения, с которого начать вывод истории чата. По умолчанию — последнее видимое сообщение.

limit
integer <int64>

Количество сообщений в ответе. По умолчанию — 50. Максимальное значение — 1000.

Ответы

Response Schema: application/json
has_next
boolean

Признак, что в ответе вернули не все сообщения.

Array of objects

Массив сообщений, отсортированный в соответствии с параметром direction из тела запроса.

Примеры запроса

Content type
application/json
{
  • "chat_id": "18b8e1f9-4ae7-461c-84ea-8e1f54d1a45e",
  • "direction": "Forward",
  • "filter": {
    • "message_ids": [
      ]
    },
  • "from_message_id": 3000000000118032000,
  • "limit": 1
}

Примеры ответа

Content type
application/json
{
  • "has_next": true,
  • "messages": [
    • {
      • "context": {
        },
      • "data": [
        ],
      • "user": {
        }
      }
    ]
}

Список товаров с некорректными ОВХ

post
/v1/product/info/wrong-volume

Возвращает список товаров с некорректными объёмно-весовыми характеристиками (ОВХ). Если вы указали размеры правильно, обратитесь в поддержку Ozon.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
cursor
string

Указатель для выборки следующих данных.

limit
integer <int64> [ 1 .. 1000 ]

Максимальное количество элементов в ответе.

Ответы

Response Schema: application/json
cursor
string

Указатель для выборки следующих данных.

Array of objects

Список товаров.

Примеры запроса

Content type
application/json
{
  • "cursor": "string",
  • "limit": 1
}

Примеры ответа

Content type
application/json
{
  • "cursor": "string",
  • "products": [
    • {
      }
    ]
}

Подтвердить заявку на отмену rFBS

post
/v2/conditional-cancellation/approve

Метод позволяет согласовать заявку на отмену в статусе ON_APPROVAL. Заказ будет отменён, а деньги вернутся покупателю.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

Request Body schema: application/json
cancellation_id
required
integer <int64>

Идентификатор заявки на отмену.

comment
string

Комментарий.

Ответы

Примеры запроса

Content type
application/json
{
  • "cancellation_id": 0,
  • "comment": "string"
}

Примеры ответа

Content type
application/json
{
  • "code": 0,
  • "details": [
    • {
      }
    ],
  • "message": "string"
}

Получить список заявок на отмену rFBS

post
/v2/conditional-cancellation/list

Метод для получения списка заявок на отмену rFBS-заказов.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

Request Body schema: application/json
object

Фильтры.

last_id
integer <int64>

Идентификатор последнего значения на странице. Оставьте это поле пустым при выполнении первого запроса.

Чтобы получить следующие значения, укажите last_id из ответа предыдущего запроса.

limit
required
integer <int32> <= 500

Количество заявок в ответе.

object

Дополнительная информация.

Ответы

Response Schema: application/json
counter
integer <int64>

Cчётчик заявок в статусе ON_APPROVAL.

last_id
integer <int64>

Идентификатор последнего значения на странице.

Чтобы получить следующие значения, передайте полученное значение в следующем запросе в параметре last_id.

Array of objects

Информация о заявках на отмену.

Array ()
approve_comment
string

Комментарий, оставленный при подтверждении или отклонении заявки на отмену.

approve_date
string <date-time>

Дата подтверждения или отклонения заявки на отмену.

auto_approve_date
string <date-time>

Дата, после которой заявка будет автоматически подтверждена.

cancellation_id
integer <int64>

Идентификатор заявки на отмену.

cancellation_initiator
string
Enum: "OZON" "SELLER" "CLIENT" "SYSTEM" "DELIVERY"

Инициатор отмены:

  • SELLER — продавец,
  • CLIENT — покупатель,
  • OZON — Ozon,
  • SYSTEM — система,
  • DELIVERY — служба доставки.
object

Причина отмены.

cancellation_reason_message
string

Комментарий к заявке на отмену, введённый инициатором отмены вручную.

cancelled_at
string <date-time>

Дата создания заявки на отмену.

order_date
string <date-time>

Дата создания заказа.

posting_number
string

Номер отправления.

source_id
integer <int64>

Предыдущий идентификатор заявки на отмену.

Используется для поддержания обратной совместимости.

object

Статус заявки на отмену.

tpl_integration_type
string

Тип интеграции со службой доставки.

Примеры запроса

Content type
application/json
{
  • "filters": {
    • "cancellation_initiator": [
      ],
    • "posting_number": [
      ],
    },
  • "limit": 500,
  • "last_id": 0,
  • "with": {
    }
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "cancellation_reason": {
        },
      • "state": {
        },
      }
    ],
  • "counter": "1",
  • "last_id": 283784254
}

Отклонить заявку на отмену rFBS

post
/v2/conditional-cancellation/reject

Метод позволяет отклонить заявку на отмену в статусе ON_APPROVAL. В параметре comment опишите причину. Заказ останется в том же статусе, и его нужно будет доставить покупателю.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

Request Body schema: application/json
cancellation_id
required
integer <int64>

Идентификатор заявки на отмену.

comment
string

Комментарий.

Ответы

Примеры запроса

Content type
application/json
{
  • "cancellation_id": 0,
  • "comment": "string"
}

Примеры ответа

Content type
application/json
{
  • "code": 0,
  • "details": [
    • {
      }
    ],
  • "message": "string"
}

Работа с квантами

Список эконом-товаров

post
/v1/product/quant/list

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
cursor
string

Указатель для выборки следующих данных.

limit
integer <int64>

Максимальное количество элементов в ответе.

visibility
string
Default: "ALL"
Enum: "ALL" "VISIBLE" "INVISIBLE" "EMPTY_STOCK" "NOT_MODERATED" "MODERATED" "DISABLED" "STATE_FAILED" "READY_TO_SUPPLY" "VALIDATION_STATE_PENDING" "VALIDATION_STATE_FAIL" "VALIDATION_STATE_SUCCESS" "TO_SUPPLY" "IN_SALE" "REMOVED_FROM_SALE" "OVERPRICED" "CRITICALLY_OVERPRICED" "EMPTY_BARCODE" "BARCODE_EXISTS" "QUARANTINE" "ARCHIVED" "OVERPRICED_WITH_STOCK" "PARTIAL_APPROVED"

Фильтр по видимости товара:

  • ALL — все товары, кроме архивных.
  • VISIBLE — товары, которые видны покупателям.
  • INVISIBLE — товары, которые не видны покупателям.
  • EMPTY_STOCK — товары, которых нет в наличии.
  • NOT_MODERATED — товары, которые не прошли модерацию.
  • MODERATED — товары, которые прошли модерацию.
  • DISABLED — товары, которые видны покупателям, но недоступны к покупке.
  • STATE_FAILED — товары, создание которых завершилось ошибкой.
  • READY_TO_SUPPLY — товары, готовые к поставке.
  • VALIDATION_STATE_PENDING — товары, которые проходят проверку валидатором на премодерации.
  • VALIDATION_STATE_FAIL — товары, которые не прошли проверку валидатором на премодерации.
  • VALIDATION_STATE_SUCCESS — товары, которые прошли проверку валидатором на премодерации.
  • TO_SUPPLY — товары, готовые к продаже.
  • IN_SALE — товары в продаже.
  • REMOVED_FROM_SALE — товары, скрытые от покупателей.
  • OVERPRICED — превышение цены.
  • CRITICALLY_OVERPRICED — критическое превышение цены.
  • EMPTY_BARCODE — пустой штрихкод.
  • BARCODE_EXISTS — штрихкод указан.
  • QUARANTINE — товар в карантине после изменения цены на 50% и больше.
  • ARCHIVED — товары в архиве.
  • OVERPRICED_WITH_STOCK — товары в продаже, цена которых выше, чем у конкурентов.
  • PARTIAL_APPROVED — товары в продаже, у которых пустое или неполное описание.

Ответы

Response Schema: application/json
cursor
string

Указатель для выборки следующих данных.

Array of objects

Эконом-товары.

total_items
integer <int32>

Остаток на всех складах, шт.

Примеры запроса

Content type
application/json
{
  • "cursor": "string",
  • "limit": 0,
  • "visibility": "ALL"
}

Примеры ответа

Content type
application/json
{
  • "cursor": "string",
  • "products": [
    • {
      • "quants": [
        • {
          }
        ]
      }
    ],
  • "total_items": 0
}

Информация об эконом-товаре

post
/v1/product/quant/info

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
quant_code
required
Array of strings [ 1 .. 1000 ] items

Список квантов с товарами.

Ответы

Response Schema: application/json
Array of objects

Эконом-товары.

Array ()
offer_id
string

Идентификатор товара в системе продавца — артикул.

product_id
integer <int64>

Идентификатор товара в системе продавца — product_id.

object

Информация о кванте.

Примеры запроса

Content type
application/json
{
  • "quant_code": [
    ]
}

Примеры ответа

Content type
application/json
{
  • "items": [
    • {
      • "quant_info": {
        • "quants": [
          • {
            • "barcodes_extended": [
              • {
                }
              ],
            • "dimensions": {
              },
            • "marketing_price": {
              },
            • "statuses": {
              }
            }
          ]
        }
      }
    ]
}

Список квантов

post
/v1/quant/list

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
cursor
string

Указатель для выборки следующих данных.

object

Фильтр.

limit
integer <int32> <= 1000

Максимальное количество значений в ответе.

sort
string

Параметр, по которому товары будут отсортированы.

sort_dir
string

Направление сортировки:

  • asc — по возрастанию,
  • desc — по убыванию.

Ответы

Response Schema: application/json
object

Список квантов.

cursor
string

Указатель для выборки следующих данных.

has_next
boolean

Признак, что в ответе вернулась только часть значений:

  • true — сделайте повторный запрос с новым параметром cursor для получения остальных значений;
  • false — ответ содержит все значения характеристики.
Array of objects

Список квантов.

Примеры запроса

Content type
application/json
{
  • "cursor": "string",
  • "filter": {
    • "created_at": {
      },
    • "cutoff": {
      },
    • "inv_quant_ids": [
      ],
    • "statuses": [
      ],
    },
  • "limit": 0,
  • "sort": "string",
  • "sort_dir": "string"
}

Примеры ответа

Content type
application/json
{
  • "result": {
    • "quants": [
      • {
        • "available_actions": [
          ],
        • "cancel_reason": {
          },
        }
      ]
    }
}

Информация о кванте и его отправлениях

post
/v1/quant/get

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
inv_quant_id
required
integer <int64>

Инвентарный идентификатор кванта.

Ответы

Response Schema: application/json
Array of objects

Информация о кванте.

Array ()
available_actions
Array of strings

Доступные действия.

awaiting_stock_due_date
string <date-time>

Дата, до которой нужно указать остатки.

object

Причина отмены отправления.

current_postings_count
integer <int64>

Текущее количество отправлений в кванте.

cutoff
string <date-time>

Время, до которого нужно собрать квант.

delivery_method_name
string

Метод доставки.

destination_place_id
integer <int64>

Идентификатор пункта назначения.

destination_place_name
string

Название пункта назначения.

filling_percent
number <float>

Наполненность кванта в процентах.

first_posting_cancellation_date
string <date-time>

Дата, когда отправления начнут отменяться, если квант не будет зарезервирован.

id
integer <int64>

Идентификатор кванта.

inv_quant_id
integer <int64>

Инвентарный идентификатор кванта.

offer_id
string

Идентификатор товара в системе продавца — артикул.

Array of objects

Отправления.

product_picture_url
string

Ссылка на фото товара.

products_price
number <float>

Суммарная стоимость товаров в кванте.

quantum_start_date
string <date-time>

Дата начала наполнения кванта.

sku
integer <int64>

Идентификатор товара в системе Ozon — SKU.

sku_name
string

Название товара.

status
string
Default: "unknown"
Enum: "unknown" "new" "filling" "fulled" "reserving" "awaiting_stock" "awaiting_packaging" "shipped" "awaiting_delivery" "delivering" "delivered" "not_accepted" "failed" "ship_in_process" "ship_failed" "quant_in_carriage" "acceptance_in_progress" "cancelled"

Статус:

  • unknown — неизвестен,
  • new — новый,
  • filling — заполняется,
  • fulled — заполнен,
  • reserving — зарезервирован,
  • awaiting_stock — ожидает на складе,
  • awaiting_packaging — ожидает упаковки,
  • shipped — отправлен,
  • awaiting_delivery — ожидает доставки,
  • delivering — доставляется,
  • delivered — доставлен,
  • not_accepted — не подтверждён,
  • failed — не набрался,
  • ship_in_process — отгружается,
  • ship_failed — не отгружен,
  • quant_in_carriage — доставляется,
  • acceptance_in_progress — ожидает подтверждение получения,
  • cancelled — отменён.
target_postings_count
integer <int64>

Необходимое количество товаров в кванте.

tpl_provider_name
string

Название службы доставки.

type
string

Тип кванта — коробка или палета.

warehouse_id
integer <int64>

Идентификатор склада.

warehouse_name
string

Название склада.

Примеры запроса

Content type
application/json
{
  • "inv_quant_id": 0
}

Примеры ответа

Content type
application/json
{
  • "result": [
    • {
      • "available_actions": [
        ],
      • "cancel_reason": {
        },
      • "postings": [
        • {
          • "cancel_reason": {
            },
          }
        ],
      }
    ]
}

Собрать отправления кванта

post
/v1/quant/ship

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
inv_quant_id
required
integer <int64>

Инвентарный идентификатор кванта.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "inv_quant_id": 0
}

Примеры ответа

Content type
application/json
{ }

Статус отправлений кванта

post
/v1/quant/status

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
inv_quant_id
required
integer <int64>

Инвентарный идентификатор кванта.

Ответы

Response Schema: application/json
status
string
Default: "unknown"
Enum: "unknown" "new" "filling" "fulled" "reserving" "awaiting_stock" "awaiting_packaging" "shipped" "awaiting_delivery" "delivering" "delivered" "not_accepted" "failed" "ship_in_process" "ship_failed" "quant_in_carriage" "acceptance_in_progress" "cancelled"

Статус:

  • unknown — неизвестен,
  • new — новый,
  • filling — заполняется,
  • fulled — заполнен,
  • reserving — зарезервирован,
  • awaiting_stock — ожидает на складе,
  • awaiting_packaging — ожидает упаковки,
  • shipped — отправлен,
  • awaiting_delivery — ожидает доставки,
  • delivering — доставляется,
  • delivered — доставлен,
  • not_accepted — не подтверждён,
  • failed — не набрался,
  • ship_in_process — отгружается,
  • ship_failed — не отгружен,
  • quant_in_carriage — доставляется,
  • acceptance_in_progress — ожидает подтверждение получения,
  • cancelled — отменён.

Примеры запроса

Content type
application/json
{
  • "inv_quant_id": 0
}

Примеры ответа

Content type
application/json
{
  • "status": "unknown"
}

Работа с отзывами

Оставить комментарий на отзыв

post
/v1/review/comment/create

Доступно только для продавцов с подпиской Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

Request Body schema: application/json
mark_review_as_processed
boolean

Обновление статуса у отзыва:

  • true — статус изменится на Processed.
  • false — статус не изменится.
parent_comment_id
string

Идентификатор родительского комментария, на который вы отвечаете.

review_id
required
string

Идентификатор отзыва.

text
required
string

Текст комментария.

Ответы

Response Schema: application/json
comment_id
string

Идентификатор комментария.

Примеры запроса

Content type
application/json
{
  • "mark_review_as_processed": true,
  • "parent_comment_id": "string",
  • "review_id": "string",
  • "text": "string"
}

Примеры ответа

Content type
application/json
{
  • "comment_id": "string"
}

Удалить комментарий на отзыв

post
/v1/review/comment/delete

Доступно только для продавцов с подпиской Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

Request Body schema: application/json
comment_id
required
string

Идентификатор комментария.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "comment_id": "string"
}

Примеры ответа

Content type
application/json
{ }

Список комментариев на отзыв

post
/v1/review/comment/list

Доступно только для продавцов с подпиской Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

Метод возвращает информацию по комментариям на отзывы, которые прошли модерацию.

Request Body schema: application/json
limit
required
integer <int32>

Ограничение значений в ответе. Минимум — 20. Максимум — 100.

offset
integer <int32>

Количество элементов, которое будет пропущено с начала списка в ответе. Например, если offset = 10, то ответ начнётся с 11-го найденного элемента.

review_id
required
string

Идентификатор отзыва.

sort_dir
string
Default: "ASC"
Enum: "ASC" "DESC"

Направление сортировки:

  • ASC — по возрастанию,
  • DESC — по убыванию.

Ответы

Response Schema: application/json
Array of objects

Информация о комментарии.

offset
integer <int32>

Количество элементов в выдаче.

Примеры запроса

Content type
application/json
{
  • "limit": 0,
  • "offset": 0,
  • "review_id": "string",
  • "sort_dir": "ASC"
}

Примеры ответа

Content type
application/json
{
  • "comments": [
    • {
      }
    ],
  • "offset": 0
}

Изменить статус отзывов

post
/v1/review/change-status

Доступно только для продавцов с подпиской Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

Request Body schema: application/json
review_ids
required
Array of strings

Массив с идентификаторами отзывов от 1 до 100.

status
required
string

Статус отзыва:

  • PROCESSED — обработанный,
  • UNPROCESSED — необработанный.

Ответы

Response Schema: application/json
object

Примеры запроса

Content type
application/json
{
  • "review_ids": [
    ],
  • "status": "string"
}

Примеры ответа

Content type
application/json
{ }

Количество отзывов по статусам

post
/v1/review/count

Доступно только для продавцов с подпиской Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

Request Body schema: application/json
object

Ответы

Response Schema: application/json
processed
integer <int32>

Количество обработанных отзывов.

total
integer <int32>

Количество всех отзывов.

unprocessed
integer <int32>

Количество необработанных отзывов.

Примеры запроса

Content type
application/json
{ }

Примеры ответа

Content type
application/json
{
  • "processed": 0,
  • "total": 0,
  • "unprocessed": 0
}

Получить информацию об отзыве

post
/v1/review/info

Доступно только для продавцов с подпиской Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

Request Body schema: application/json
review_id
required
string

Идентификатор отзыва.

Ответы

Response Schema: application/json
comments_amount
integer <int32>

Количество комментариев к отзыву.

dislikes_amount
integer <int32>

Количество дизлайков на отзыве.

id
string

Идентификатор отзыва.

is_rating_participant
boolean

true, если отзыв участвует в подсчёте рейтинга.

likes_amount
integer <int32>

Количество лайков на отзыве.

order_status
string

Статус заказа, на который покупатель оставил отзыв:

  • DELIVERED — доставлен,
  • CANCELLED — отменён.
Array of objects

Информация об изображении.

photos_amount
integer <int32>

Количество изображений у отзыва.

published_at
string <date-time>

Дата публикации отзыва.

rating
integer <int32>

Оценка отзыва.

sku
integer <int64>

Идентификатор товара в системе Ozon — SKU.

status
string

Статус отзыва:

  • UNPROCESSED — не обработан,
  • PROCESSED — обработан.
text
string

Текст отзыва.

Array of objects

Информация о видео.

videos_amount
integer <int32>

Количество видео у отзыва.

Примеры запроса

Content type
application/json
{
  • "review_id": "string"
}

Примеры ответа

Content type
application/json
{
  • "comments_amount": 0,
  • "dislikes_amount": 0,
  • "id": "string",
  • "is_rating_participant": true,
  • "likes_amount": 0,
  • "order_status": "string",
  • "photos": [
    • {
      }
    ],
  • "photos_amount": 0,
  • "published_at": "2019-08-24T14:15:22Z",
  • "rating": 0,
  • "sku": 0,
  • "status": "string",
  • "text": "string",
  • "videos": [
    • {
      }
    ],
  • "videos_amount": 0
}

Получить список отзывов

post
/v1/review/list

Доступно только для продавцов с подпиской Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

Метод не возвращает параметры «Достоинства» и «Недостатки», если они есть в отзывах на товар. Эти параметры устарели, в новых отзывах их нет.

Request Body schema: application/json
last_id
string

Идентификатор последнего отзыва на странице.

limit
required
integer <int32>

Количество отзывов в ответе. Минимум — 20, максимум — 100.

sort_dir
string

Направление сортировки:

  • ASC — по возрастанию,
  • DESC — по убыванию.
status
string

Статусы отзывов:

  • ALL — все,
  • UNPROCESSED — необработанные,
  • PROCESSED — обработанные.

Ответы

Response Schema: application/json
has_next
boolean

true, если в ответе вернули не все отзывы.

last_id
string

Идентификатор последнего отзыва на странице.

Array of objects

Информация об отзыве.

Примеры запроса

Content type
application/json
{
  • "last_id": "string",
  • "limit": 0,
  • "sort_dir": "string",
  • "status": "string"
}

Примеры ответа

Content type
application/json
{
  • "has_next": true,
  • "last_id": "string",
  • "reviews": [
    • {
      }
    ]
}

Работа с вопросами и ответами

Создать ответ на вопрос

post
/v1/question/answer/create

Метод доступен по подписке Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
question_id
required
string

Идентификатор вопроса.

sku
required
int64

Идентификатор товара в системе Ozon — SKU.

text
required
string

Текст ответа объёмом от 2 до 3000 символов.

Ответы

Response Schema: application/json
answer_id
string

Идентификатор ответа на вопрос.

Примеры запроса

Content type
application/json
{
  • "question_id": "0192a009-769f-7ee9-b412-893045171a66",
  • "sku": 646399170,
  • "text": "текст"
}

Примеры ответа

Content type
application/json
{
  • "answer_id": "0192e7ce-e12c-7a74-afc7-26e877799204"
}

Удалить ответ на вопрос

post
/v1/question/answer/delete

Метод доступен по подписке Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
answer_id
required
string

Идентификатор ответа.

sku
required
int64

Идентификатор товара в системе Ozon — SKU.

Ответы

Response Schema: application/json
object

Ответ удалён

Примеры запроса

Content type
application/json
{
  • "answer_id": "0192e7ce-e12c-7a74-afc7-26e877799204",
  • "sku": 646399170
}

Примеры ответа

Content type
application/json
{ }

Список ответов на вопрос

post
/v1/question/answer/list

Метод доступен по подписке Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
last_id

Идентификатор последнего значения на странице.

Если запрос первый, оставьте поле пустым. Для следующих значений указывайте last_id из ответа предыдущего запроса.

question_id
required
string

Идентификатор вопроса.

sku
required
int64

Идентификатор товара в системе Ozon — SKU.

Ответы

Response Schema: application/json
Array of objects

Ответы.

last_id
string

Идентификатор последнего значения на странице.

Чтобы получить следующие значения, передайте полученное значение в следующем запросе в параметре last_id.

Примеры запроса

Content type
application/json
{
  • "last_id": "string",
  • "question_id": "019228a7-91d8-76af-a73a-e989dfac7ac8",
  • "sku": 646399170
}

Примеры ответа

Content type
application/json
{
  • "answers": [
    • {
      }
    ],
  • "last_id": "string"
}

Изменить статус вопросов

post
/v1/question/change-status

Метод доступен по подписке Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
question_ids
required
Array of strings

Идентификаторы вопросов.

status
required
string

Статусы вопросов:

  • NEW — новые,
  • VIEWED — просмотренные,
  • PROCESSED — обработанные.

Ответы

Response Schema: application/json
object

Статус изменён.

Примеры запроса

Content type
application/json
{
  • "question_ids": [
    ],
  • "status": "VIEWED"
}

Примеры ответа

Content type
application/json
{ }

Количество вопросов по статусам

post
/v1/question/count

Метод доступен по подписке Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Ответы

Response Schema: application/json
all
int64

Всего вопросов.

new
int64

Новые вопросы.

processed
int64

Обработанные вопросы.

unprocessed
int64

Необработанные вопросы.

viewed
int64

Просмотренные вопросы.

Примеры ответа

Content type
application/json
{
  • "all": 10,
  • "new": 3,
  • "processed": 4,
  • "unprocessed": 1,
  • "viewed": 1
}

Информацию по вопросу

post
/v1/question/info

Метод доступен по подписке Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
question_id
required
string

Идентификатор вопроса

Ответы

Response Schema: application/json
answers_count
int64

Количество ответов на вопрос.

author_name
string

Автор вопроса.

id
string

Идентификатор вопроса.

product_url
string

Ссылка на товар.

published_at
timestamp

Дата публикации вопроса.

question_link
string

Ссылка на вопрос.

sku
int64

Идентификатор товара в системе Ozon — SKU.

status
enum

Статус вопроса:

  • NEW — новый,
  • ALL — все вопросы,
  • VIEWED — просмотренный,
  • PROCESSED — обработанный,
  • UNPROCESSED — необработанный.
text
string

Текст вопроса.

Примеры запроса

Content type
application/json
{
  • "question_id": "string"
}

Примеры ответа

Content type
application/json
{}

Список вопросов

post
/v1/question/list

Метод доступен по подписке Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
object

Фильтр.

last_id
string

Идентификатор последнего значения на странице.

Оставьте это поле пустым при выполнении первого запроса. Чтобы получить следующие значения, укажите last_id из ответа предыдущего запроса.

Ответы

Response Schema: application/json
Array of objects

Вопросы.

last_id
string

Идентификатор последнего значения на странице.

Чтобы получить следующие значения, передайте полученное значение в следующем запросе в параметре last_id.

Примеры запроса

Content type
application/json
{
  • "filter": {
    },
  • "last_id": "string"
}

Примеры ответа

Content type
application/json
{}

Товары с наибольшим количеством вопросов

post
/v1/question/top_sku

Метод доступен по подписке Premium Plus.

Вы можете оставить обратную связь по этому методу в комментариях к обсуждению в сообществе разработчиков Ozon for dev.

header Parameters
Client-Id
required
string

Идентификатор клиента.

Api-Key
required
string

API-ключ.

Request Body schema: application/json
limit
required
int64

Количество значений в ответе: максимум — 100, минимум — 1.

Ответы

Response Schema: application/json
sku
Array of strings <int64>

Список Идентификаторы товаров в системе Ozon — SKU.

Примеры запроса

Content type
application/json
{
  • "limit": "100"
}

Примеры ответа

Content type
application/json
{
  • "sku": [
    ]
}

Частые ошибки

Все методы

Ошибка Описание
Circle is open Если выполняется большое количество запросов, система блокирует работу метода. В течение нескольких минут метод начнет работать как обычно.
Internal error Сервер не успел обработать запрос.
Invalid Api-Key, please check the key and try again Неверный Api-Key: проверьте ключ и повторите попытку.
Api-key is deactivated, use another one or generate a new one Api-Key деактивирован: используйте другой ключ или сгенерируйте новый.
Api-Key is missing a required role for a method У Api-Key нет нужной роли для работы метода.
Api-Key is restricted to specific IP addresses Доступ к Api-Key разрешён только с определённых IP-адресов.

/v4/fbs/posting/product/exemplar/validate

Ошибка Описание
GTD_MUST_BE_SPECIFIED_FOR_PRODUCT_COUNTRY Не указан номер ГТД. Если ГТД нет, передайте is_gtd_absent: true.

/v2/products/stocks и /v1/product/import/stocks

Ошибка Описание
Fatal error: You have more than 1 FBS warehouses. Please use API Method POST /v2/products/stocks У вас несколько складов и вы обновляете остатки методом /v1/product/import/stocks. Обновите остатки методом /v2/products/stocks.
product_is_not_created Товар не прошёл модерацию, поэтому обновить остатки пока нельзя. Дождитесь статуса price_sent и попробуйте ещё раз.
offer_id_not_found Товара с таким артикулом нет в личном кабинете.
FLAMMABLE_ONLY_ON_SELF_OR_PROVIDER_DELIVERY Легковоспламеняющиеся товары можно продавать только со своего склада с доставкой самостоятельно или сторонней службой. Выберите другой склад или создайте новый и попробуйте ещё раз.
WAREHOUSE_NOT_FOUND Склад warehouse_id не найден. Проверьте наличие ошибок в ID склада и его статус — он должен быть активный.
PRODUCT_HAS_NOT_BEEN_TAGGED_YET Товар ещё не пометили тегами «КГТ» или «неКГТ», так как не указаны габариты товара или система для расстановки тегов ещё не обработала его.
NON_KGT_ON_KGT_WAREHOUSE Попытка установить или обновить остаток некрупногабаритного товара на КГТ складе.
PRICE_IS_NOT_SENT Товар ещё не создан или находится на стадии обновления.
MP_DELIVERY_ONLY_3PL_ERROR Товар нельзя размещать на складе с методом доставки «Ozon логистика».
TOO_MANY_REQUESTS Вы слишком часто обновляли остатки для одного артикула. Остатки для одного артикула можно обновлять не чаще одного раза в 2 минуты.
MULTIBOX_NOT_ALLOWED_FOR_FBS При работе по схеме FBS нельзя объединить товары из нескольких коробок в один товар. Удалите значение из поля stock и повторите попытку.
OVER_MAX_OVH_NON_KGT Через выбранный склад нельзя продавать крупногабаритные товары. Выберите другой склад или создайте новый и повторите попытку.
OVER_MAX_OVH_KGT Вес или габариты товара превышают максимальные значения для выбранного склада. Измените характеристики товара или выберите другой склад.
SOURCE_TYPE_NOT_FOUND У товара нет SKU. Проверьте, что товар создан и правильно настроен.
Request validation error: invalid ProductsStocksRequest.Stocks[0]: embedded message failed validation В запросе не указан идентификатор склада. Его можно узнать с помощью метода /v1/warehouse/list.
STOCK_TOO_BIG Вы указали слишком большое значение для остатка товара. Укажите количество меньше миллиона и повторите запрос.
FLAMMABLE_ON_NON_KGT_WAREHOUSE Легковоспламеняемые товары можно продавать только со склада для крупногабаритных товаров. Выберите другой склад или создайте новый.
NOT_FOUND_ERROR Товар не найден в личном кабинете.
SIZE_REQUIRED_FOR_NOT_UNIQUE_OFFER_ID Артикул совпадает с артикулом другого товара. Для обычного товара укажите параметр quant_size = 1, а для кванта — quant_size = 2 и больше.
CB_DELIVERY_ONLY_FBP Этот товар доступен к продаже только с FBP склада.

/v2/posting/fbo/list

Ошибка Описание
MAX_OFFSET_EXCEEDED Вы превысили лимит количества элементов в запросе. Убедитесь, что значение в поле offset не больше 20000.

/v4/posting/fbs/ship

Ошибка Описание
TRANSITION_IS_NOT_POSSIBLE Вы передали некорректный порядок статусов заказов rFBS.
HAS_INCORRECT_TPL_INTEGRATION_TYPE Попытка передать статус на заказ rFBS при доставке интегрированной службой доставки.
POSTING_NOT_FOUND Заказа нет в личном кабинете партнёра.
POSTING_ALREADY_CANCELLED Заказ уже отменён.
POSTING_ALREADY_SHIPPED Заказ уже собран.
HAS_INCORRECT_STATUS У заказа некорректный статус.
HAS_INCORRECT_PRODUCT_QUANTITY Неправильное количество продуктов или неправильный SKU в запросе.
UNKNOW_PRODUCT/UNKNOWN_PRODUCT_DEFINED Указан неверный идентификатор товара в системе продавца — product_id. Проверьте, что в поле product_id вы указали идентификатор товара в системе Ozon — SKU.
EXEMPLAR_INFO_ALREADY_DEFINED Информация об экземплярах товара уже обновлена. Передавать данные повторно не нужно.
MANDATORY_MARK_REDUNDANT Для товара не нужно передавать код маркировки.
EXEMPLAR_INFO_NOT_FILLED_COMPLETELY Убедитесь, что вы передали всю информацию по экземплярам товаров в заказе.
SHIP_FBP_POSTINGS_IS_FORBIDDEN FBP постинг не требует сборки.

/v2/posting/fbs/package-label

Ошибка Описание
The next postings aren't ready Товар ещё не готов к печати маркировки.
INVALID_ARGUMENT Печать этикетки возможна только для заказов со статусом «Ожидает отгрузки» — awaiting_deliver. Проверьте, что у отправления верный статус.
NO_POSTINGS_FOR_BATCH_DOWNLOAD В запросе нет заказов со статусом «Ожидает отгрузки».

/v2/posting/fbs/act/create

Ошибка Описание
can't create carriage Перевозка ещё не готова к созданию. Добавьте акты на отгрузку.
Company has no FBS-warehouses У вас нет созданного склада FBS.
DELIVERY_METHOD_NOT_FOUND Вы передали некорректный идентификатор метода доставки — delivery_method_id.
first_mile_absent Для метода доставки не указан способ отгрузки. Подробнее о настройке склада
first_mile_is_changing Обновляются настройки склада. Отгрузка станет доступна после обновления.
has_overflow Пункт перегружен. Выберите другой, чтобы сроки доставки не увеличивались.
has_postings_with_registration_error Часть отправлений не может попасть в акт из-за ошибки регистрации в сервисе доставки.
has_seller_returns_in_stock Заберите возвраты.
has_surge Пункт приёма переполнен и стоимость отгрузки временно увеличена. Для экономии выберите менее загруженный пункт.
new_postings_are_possible В отгрузку ещё могут попасть новые отправления. Используйте метод, когда закончится сегодняшнее время на сборку заказов.
no_postings Для выбранного метода нет доступных отправлений.
non_carriageable Отгрузка не требуется.
not_accepted_on_sc Обработайте отправления на вкладке Спорные в личном кабинете. Чтобы добавить оправление в уже созданную отгрузку, отмените предыдущую и создайте новую.
not_packaged У вас есть отправления, которые нужно передать в доставку сегодня — добавьте их в отгрузку.
not_registered Регистрируем отправления в сервисе доставки. Сформируйте акт, когда все отправления получат статус awaiting_deliver — готов к отгрузке.
other Возникла ошибка. Обратитесь за помощью в поддержку.
outdated Указана прошедшая дата.
package_time_not_passed Время для формирования отгрузки ещё не наступило.
partial_carriage_formed Все частичные перевозки созданы.
partial_carriage_in_proccess Создайте ещё несколько частичных перевозок.
posting_statuses_not_ready Формируем отгрузку. Повторите запрос через несколько минут.
there_are_incomplete_carriages Есть незавершённые перевозки.
Trying set ContainersCount to not HasEntrustedAcceptance company Чтобы передать количество грузовых мест, подключитесь к доверительной приёмке. Подробнее о доверительной приёмке
will_be_partial_carriage Создайте несколько частичных перевозок.
Incorrect_carriage_status Перевозка ещё не сформировалась. Акт должен быть в статусе sended или formed. Чтобы получить статус, используйте метод /v2/posting/fbs/act/list.

/v1/product/import/prices

Ошибка Описание
invalid_cat egory_price Попытка установить слишком высокую или слишком низкую цену на товар.
discount_for_average_price_is_too_small Слишком маленькая скидка. Если цена после скидки от 400 до 10 000 рублей включительно, разница между ценами до и после скидки должна быть больше 5%.
discount_for_low_price_is_too_small Слишком маленькая скидка. Если цена после скидки ниже 400 рублей включительно, разница между ценами до и после скидки должна быть больше 20 рублей.
discount_too_big Слишком большая скидка. Разница между ценами до и после скидки должна быть менее 90%.
discount_for_top_price_is_too_small Слишком маленькая скидка. Если цена после скидки выше 10 000 рублей, разница между ценами до и после скидки должна быть больше 500 рублей.
price_negative Попытка установить отрицательную цену.
NOT_FOUND_ERROR Товара с таким идентификатором нет в личном кабинете.

/v3/product/import

Ошибка Описание
SPU_already_exists Товар с такими характеристиками уже существует.
"Invalid_state" - Product is not ready to supply Товар не готов к обновлению остатков. Возможно, товар не создан или аккаунт не активирован.
Incorrect_density Товар не прошёл проверку на плотность. Указанная вами плотность находится вне допустимого диапазона. Минимальное значение плотности — 0,001, максимальное — 13,55.

Плотность рассчитывается по формуле: вес × 1000 ÷ (высота × ширина × глубина).

Также проверьте, что вы используете корректные значения массы и объёма для вашего товара.

/v1/product/import/info

Ошибка Описание
result: items: 0 Убедитесь, что указана корректная категория товара и проставлен НДС .

v2/posting/fbs/cancel

Ошибка Описание
HAS_INCORRECT_CANCEL_REASON Указан неправильный идентификатор отмены заказа.

/v5/fbs/posting/product/exemplar/set и /v4/fbs/posting/product/exemplar/status

Ошибка Описание
GTD_IS_REQUIRED_ONLY_FOR_LEGAL_CUSTOMER Грузовую таможенную декларацию должны передавать только юридическим лицам.
EXEMPLAR_ID does not belong to product PRODUCT_ID Идентификатор экземпляра exemplar_id не соответствует идентификатору товара product_id. Получите корректный exemplar_id методом /v5/fbs/posting/product/exemplar/create-or-get.
Posting must have 'awaiting_packaging' status У заказа некорректный статус. Для передачи данных или проверки статуса отправление должно быть в статусе «Ожидает сборки» — awaiting_packaging.

Введение

В разделе описано, как подключить пуш-уведомления, чтобы получать от Ozon на свой сервис информацию о событиях:

  • создании нового отправления,
  • отмене отправления,
  • изменении статуса отправления,
  • изменении даты доставки или отгрузки отправления.

Также можно получать информацию о сообщениях и уведомлениях, которые не были доставлены из-за недоступности вашего сервиса.

Как подключить



Первичное подключение пуш-уведомлений

  1. В личном кабинете продавца перейдите в раздел Настройки → Уведомления.
  2. На вкладке Push уведомления включите получение уведомлений.
  3. Нажмите Подключить.
  4. Введите URL-адрес сервиса, на который будут отправляться уведомления. Например, https://www.example.com/api/method.
  5. Нажмите Проверить. Ozon отправит запрос для проверки соединения, на который должен ответить ваш сервис. Если соединение установлено, появится сообщение «Данный url доступен для подключения».
  6. Нажмите Сохранить.
  7. В блоке Настройки подключения в выпадающем списке Типы уведомлений выберите нужные.
    Описания уведомлений

Отключить уведомления можно в разделе Настройки → Уведомления на вкладке Push уведомления.

Коды ошибок при подключении пуш-уведомлений

Ошибка Описание Решение
REQUEST_ERROR Запрос не отправлен, нет подключения по указанному адресу. Проверьте, что ваш сервис работает.
REQUEST_TIMEOUT Превышено время ожидания запроса. Увеличьте время ожидания запроса.
SERVER_FAULT Ваш сервис вернул внутреннюю ошибку сервера. Изучите логи сервера, обновите серверное ПО, увеличьте выделенные ресурсы или обратитесь к администратору сервера.
STATUS_CODE_NOT_OK HTTP-статус ответа сервиса не равен 200. Проверьте передаваемый код статуса.
EMPTY_BODY Тело ответа пустое или отсутствует. Проверьте, что ответ на сервере сформирован правильно, и, что данные корректно передаются.
INVALID_BODY Некорректный формат тела ответа. Проверьте формат ответа и убедитесь, что заголовок Content-Type равен application/json.
INVALID_JSON Ошибка при разборе или валидации JSON-данных. Проверьте правильность JSON-данных и исправьте ошибки в синтаксисе.
WRONG_RESULT_FIELD Ваш сервис вернул тело ответа не по шаблону. Проверьте, что формат ответа соответствует шаблону.
Подробнее о шаблоне
WRONG_RESULT_TIME_FIELD Некорректное поле time в теле ответа. Проверьте формат времени в ответе.

Изменить адрес сервиса

  1. В личном кабинете продавца перейдите в раздел Настройки → Интеграции.
  2. На вкладке Push уведомления нажмите Редактировать.
  3. Введите URL-адрес сервиса, на который будут отправляться уведомления.
  4. Нажмите Проверить. Ozon отправит запрос для проверки соединения, на который должен ответить ваш сервис. Если соединение установлено, появится сообщение «Данный url доступен для подключения».
  5. Нажмите Сохранить.

Запрос для проверки соединения

Что отправляет Ozon

{
   "message_type": "string",
   "time": "2019-08-24T14:15:22Z"
}
Параметр
Тип Формат Описание
message_type string Тип уведомления — TYPE_PING.
time string date-time Дата и время отправки уведомления в формате UTC.

Что должен отвечать ваш сервис

Если уведомление получено успешно

При успешной обработке уведомления сервис должен вернуть ответ с кодом HTTP 200:

{
   "version": "string",
   "name": "string",
   "time": "2019-08-24T14:15:22Z"
}
Параметр
Тип Формат Описание
version string Версия приложения.
name string Название приложения.
time string date-time Дата и время начала обработки уведомления в формате UTC.

Если произошла ошибка

При ошибке во время обработки уведомления сервис должен вернуть ответ с кодом HTTP из групп 4xx или 5xx:

{
   "error": {
      "code": "ERROR_UNKNOWN",
      "message": "ошибка",
      "details": null
   }
}
Параметр
Тип Формат Описание
error object Информация об ошибке.
code string Код ошибки:
ERROR_UNKNOWN — неизвестная ошибка.
ERROR_PARAMETER_VALUE_MISSED — не указано значение одного или нескольких параметров.
ERROR_REQUEST_DUPLICATED — дублирующийся запрос.
message string Детальное описание ошибки.
details string Дополнительная информация.

Повторная отправка уведомлений

Интервалы повторной отправки

Если уведомление не доставлено, через несколько секунд система попытается отправить запрос ещё несколько раз. Интервал между попытками будет постепенно увеличиваться. Когда он достигнет максимального значения в 10 минут, будет ещё 5 попыток каждые 10 минут.

Автоматическая приостановка отправки уведомлений

Если сообщение по-прежнему не получится доставить, попытки отправки запроса прекратятся.

Отправка всех уведомлений будет приостановлена, если соблюдено хотя бы одно из условий:

  • сервис недоступен;
  • сервис возвращает ошибки в течение 24 часов;
  • ответов 200 меньше половины от всех уведомлений;
  • время обработки уведомлений больше 5 секунд.

Чтобы снова получать уведомления, в личном кабинете продавца повторно подтвердите URL-адрес сервиса.

Уведомления, которые отправляет Ozon


Для каждого из типов уведомлений Ozon отправляет REST-запросы на адрес вашего сервиса. Ваш сервис должен отвечать по стандартам REST API.

Тип Назначение
TYPE_PING Проверка статуса готовности сервиса при первичном подключении и периодически после подключения
TYPE_NEW_POSTING Новое отправление
TYPE_POSTING_CANCELLED Отмена отправления
TYPE_STATE_CHANGED Изменение статуса отправления
TYPE_CUTOFF_DATE_CHANGED Изменение даты отгрузки отправления
TYPE_DELIVERY_DATE_CHANGED Изменение даты доставки отправления
TYPE_CREATE_OR_UPDATE_ITEM Создание и обновление товара или ошибка в процессе
TYPE_CREATE_ITEM Создание товара или ошибка при его создании
TYPE_UPDATE_ITEM Обновление товара или ошибка при обновлении
TYPE_PRICE_INDEX_CHANGED Изменение ценового индекса товара
TYPE_STOCKS_CHANGED Изменение остатков на складах продавца
TYPE_NEW_MESSAGE Новое сообщение в чате
TYPE_UPDATE_MESSAGE Изменение сообщения в чате
TYPE_MESSAGE_READ Ваше сообщение прочитано покупателем или поддержкой
TYPE_CHAT_CLOSED Чат закрыт

Новое отправление

Уведомления приходят только для FBS и rFBS отправлений:

{
  "message_type": "TYPE_NEW_POSTING",
  "posting_number": "24219509-0020-1",
  "products": [
    {
      "sku": 147451959,
      "quantity": 2
    }
  ],
  "in_process_at": "2021-01-26T06:56:36.294Z",
  "warehouse_id": 18850503335000,
  "seller_id": 15
}
Параметр
Тип Формат Описание
message_type string Тип уведомления — TYPE_NEW_POSTING.
posting_number string Номер отправления.
products array Информация о товарах.
sku integer int64 Идентификатор товара в системе Ozon — SKU.
quantity integer int64 Количество товара.
in_process_at string date-time Дата и время начала обработки отправления в формате UTC.
warehouse_id integer int64 Идентификатор склада, на котором хранятся товары для этого отправления.
seller_id integer int64 Идентификатор продавца.

Отмена отправления

Уведомления приходят только для FBS и rFBS отправлений:

{
  "message_type": "TYPE_POSTING_CANCELLED",
  "posting_number": "24219509-0020-1",
  "products": [
    {
      "sku": 147451959,
      "quantity": 1
    }
  ],
  "old_state": "posting_transferred_to_courier_service",
  "new_state": "posting_canceled",
  "changed_state_date": "2021-01-26T06:56:36.294Z",
  "reason": {
    "id": 0,
    "message": "string"
  },
  "warehouse_id": 0,
  "seller_id": 15
}
Параметр
Тип Формат Описание
message_type string Тип уведомления — TYPE_POSTING_CANCELLED.
posting_number string Номер отправления.
products array Информация о товарах.
sku integer int64 Идентификатор товара в системе Ozon — SKU.
quantity integer int64 Количество товара.
old_state string Предыдущий статус отправления.
new_state string Новый статус отправления: posting_canceled — отменено.
changed_state_date string date-time Дата и время изменения статуса отправления в формате UTC.
reason object Информация о причине отмены.
id integer int64 Идентификатор причины отмены.
message string Причина отмены.
warehouse_id integer int64 Идентификатор склада, на котором хранятся товары для этого отправления.
seller_id integer int64 Идентификатор продавца.

Статусы отправлений

  • posting_acceptance_in_progress — идёт приёмка,
  • posting_created — создано,
  • posting_transferring_to_delivery — передаётся в доставку,
  • posting_in_carriage — в перевозке,
  • posting_not_in_carriage — не добавлен в перевозку,
  • posting_in_client_arbitration — клиентский арбитраж доставки,
  • posting_on_way_to_city — на пути в город,
  • posting_transferred_to_courier_service — передаётся курьеру,
  • posting_in_courier_service — курьер в пути,
  • posting_on_way_to_pickup_point — на пути в пункт выдачи,
  • posting_in_pickup_point — в пункте выдачи,
  • posting_conditionally_delivered — условно доставлено,
  • posting_driver_pick_up — у водителя,
  • posting_not_in_sort_center — не принят на сортировочном центре.

Изменение статуса отправления

Соответствие статусных моделей Seller API и статусов пуш-модели.

Seller API Push-модель
Статус Описание Статус Описание
acceptance_in_progress Идёт приёмка. posting_acceptance_in_progress Идёт приёмка.
awaiting_approve Ожидает подтверждения. posting_created Создана.
awaiting_packaging Ожидает упаковки. posting_created Создана.
awaiting_registration Ожидает регистрации. posting_awaiting_registration Ожидает регистрации.
awaiting_deliver Ожидает отгрузки. posting_transferring_to_delivery Передаётся в доставку.
posting_in_carriage В перевозке.
posting_not_in_carriage Не добавлен в перевозку.
arbitration Арбитраж. posting_in_arbitration Арбитраж.
client_arbitration Клиентский арбитраж доставки. posting_in_client_arbitration Клиентский арбитраж.
delivering Доставляется. posting_on_way_to_city На пути в ваш город.
posting_transferred_to_courier_service Передаётся курьеру.
posting_in_courier_service Курьер в пути.
posting_on_way_to_pickup_point На пути в пункт выдачи.
posting_in_pickup_point В пункте выдачи.
posting_conditionally_delivered Условно доставлено.
driver_pickup У водителя. posting_driver_pick_up У водителя.
delivered Доставлено. posting_delivered Доставлено.
posting_received Получено.
cancelled Отменено. posting_canceled Отменено.
not_accepted Не принято на сортировочном центре. posting_not_in_sort_center Не принято на сортировочном центре.

Уведомления приходят только для FBS и rFBS отправлений.

{
  "message_type": "TYPE_STATE_CHANGED",
  "posting_number": "24219509-0020-2",
  "new_state": "posting_delivered",
  "changed_state_date": "2021-02-02T15:07:46.765Z",
  "warehouse_id": 0,
  "seller_id": 15
}
Параметр
Тип Формат Описание
message_type string Тип уведомления — TYPE_STATE_CHANGED.
posting_number string Номер отправления.
new_state string Новый статус отправления.
changed_state_date string date-time Дата и время изменения статуса отправления в формате UTC.
warehouse_id integer int64 Идентификатор склада, на котором хранятся товары для этого отправления.
seller_id integer int64 Идентификатор продавца.

Статусы отправлений

  • posting_acceptance_in_progress — идёт приёмка,
  • posting_transferring_to_delivery — передаётся в доставку,
  • posting_in_carriage — в перевозке,
  • posting_not_in_carriage — не добавлен в перевозку,
  • posting_in_arbitration — арбитраж,
  • posting_in_client_arbitration — клиентский арбитраж доставки,
  • posting_on_way_to_city — на пути в город,
  • posting_transferred_to_courier_service — передаётся курьеру,
  • posting_in_courier_service — курьер в пути,
  • posting_on_way_to_pickup_point — на пути в пункт выдачи,
  • posting_in_pickup_point — в пункте выдачи,
  • posting_conditionally_delivered — условно доставлено,
  • posting_driver_pick_up — у водителя,
  • posting_delivered — доставлено,
  • posting_not_in_sort_center — не принят на сортировочном центре.

Изменение даты отгрузки отправления


Уведомления приходят только для FBS и rFBS отправлений:

{
  "message_type": "TYPE_CUTOFF_DATE_CHANGED",
  "posting_number": "24219509-0020-2",
  "new_cutoff_date": "2021-11-24T07:00:00Z",
  "old_cutoff_date": "2021-11-21T10:00:00Z",
  "warehouse_id": 0,
  "seller_id": 15
}
Параметр
Тип Формат Описание
message_type string Тип уведомления — TYPE_CUTOFF_DATE_CHANGED.
posting_number string Номер отправления.
new_cutoff_date string date-time Новые дата и время отгрузки в формате UTC.
old_cutoff_date string date-time Предыдущие дата и время отгрузки в формате UTC.
warehouse_id integer int64 Идентификатор склада, на котором хранятся товары для этого отправления.
seller_id integer int64 Идентификатор продавца.

Изменение даты доставки отправления

Уведомление, которое отправляет Ozon:

{
  "message_type": "TYPE_DELIVERY_DATE_CHANGED",
  "posting_number": "24219509-0020-2",
  "new_delivery_date_begin": "2021-11-24T07:00:00Z",
  "new_delivery_date_end": "2021-11-24T16:00:00Z",
  "old_delivery_date_begin": "2021-11-21T10:00:00Z",
  "old_delivery_date_end": "2021-11-21T19:00:00Z",
  "warehouse_id": 0,
  "seller_id": 15
}
Параметр
Тип Формат Описание
message_type string Тип уведомления — TYPE_DELIVERY_DATE_CHANGED.
posting_number string Номер отправления.
new_delivery_date_begin string date-time Новые дата и время начала доставки в формате UTC.
new_delivery_date_end string date-time Новые дата и время окончания доставки в формате UTC.
old_delivery_date_begin string date-time Предыдущие дата и время начала доставки в формате UTC.
old_delivery_date_end string date-time Предыдущие дата и время окончания доставки в формате UTC.
warehouse_id integer int64 Идентификатор склада, на котором хранятся товары для этого отправления.
seller_id integer int64 Идентификатор продавца.

Создание или обновление товара

Уведомление, которое отправляет Ozon:

{
    "message_type": "TYPE_CREATE_OR_UPDATE_ITEM",
    "seller_id": 0,
    "offer_id": "string",
    "product_id": 0,
    "is_error": false,
    "changed_at": "2022-09-01T14:15:22Z"
}
Параметр
Тип Формат Описание
seller_id integer int64 Идентификатор продавца.
message_type string Тип уведомления — TYPE_CREATE_OR_UPDATE_ITEM.
offer_id string Идентификатор товара в системе продавца — артикул.
product_id integer int64 Идентификатор товара в системе продавца — product_id.
is_error boolean Признак, что при создании или обновлении товара возникли ошибки:
true — были ошибки, товар не создан или не обновлён;
false — товар создан или обновлён без ошибок.
changed_at string date-time Дата и время изменения.

Создание товара

Уведомление, которое отправляет Ozon:

{
    "message_type": "TYPE_CREATE_ITEM",
    "seller_id": 0,
    "offer_id": "string",
    "product_id": 0,
    "is_error": false,
    "changed_at": "2021-09-01T14:15:22Z"
}
Параметр
Тип Формат Описание
seller_id integer int64 Идентификатор продавца.
message_type string Тип уведомления — TYPE_CREATE_ITEM.
offer_id string Идентификатор товара в системе продавца — артикул.
product_id integer int64 Идентификатор товара в системе продавца — product_id.
is_error boolean Признак, что при создании товара возникли ошибки:
true — были ошибки, товар не создан;
false — товар создан без ошибок.
changed_at string date-time Дата и время изменения.

Обновление товара

Уведомление, которое отправляет Ozon:

{
    "message_type": "TYPE_UPDATE_ITEM",
    "seller_id": 0,
    "offer_id": "string",
    "product_id": 0,
    "is_error": false, 
    "changed_at": "2021-09-01T14:15:22Z"
}
Параметр
Тип Формат Описание
seller_id integer int64 Идентификатор продавца.
message_type string Тип уведомления — TYPE_UPDATE_ITEM.
offer_id string Идентификатор товара в системе продавца — артикул.
product_id integer int64 Идентификатор товара в системе продавца — product_id.
is_error boolean Признак, что при обновлении товара возникли ошибки:
true — были ошибки, товар не создан;
false — товар создан без ошибок.
changed_at string date-time Дата и время изменения.

Изменение ценового индекса товара

Уведомление, которое отправляет Ozon:

{
    "seller_id": 0,
    "message_type": "string",
    "updated_at":"2022-06-21T05:52:46.648533678Z",
    "sku": 0,
    "product_id": 0,
    "price_index": 0
}
Параметр
Тип Формат Описание
seller_id integer int64 Идентификатор продавца.
message_type string Тип уведомления — TYPE_PRICE_INDEX_CHANGED.
updated_at string date-time Дата и время изменения ценового индекса.
sku integer int64 Идентификатор товара в системе Ozon — SKU.
product_id integer int64 Идентификатор товара в системе продавца — product_id.
price_index integer int64 Ценовой индекс.

Изменение остатков на складах продавца

Уведомление, которое отправляет Ozon:

{
  "message_type": "string",
  "seller_id": 0,
  "items": [
    {
      "product_id": 0,
      "sku": 0,
      "updated_at": "2021-09-01T14:15:22Z",
      "stocks": [
        {
          "warehouse_id": 0,
          "present": 0,
          "reserved": 0
        }
      ]
    }
  ]
}
Параметр
Тип Формат Описание
seller_id integer int64 Идентификатор продавца.
message_type string Тип уведомления — TYPE_STOCKS_CHANGED.
items array Массив с данными товаров.
updated_at string date-time Дата и время изменения.
sku integer int64 SKU товара при работе по схемам FBS или rFBS.
product_id integer int64 Идентификатор товара в системе продавца — product_id.
stocks array Массив с данными по остаткам товара.
warehouse_id integer int64 Идентификатор склада.
present integer int64 Общее количество товара на складе.
reserved integer int64 Количество зарезервированных товаров на складе.

Новое сообщение в чате

{  
    "message_type": "TYPE_NEW_MESSAGE",
    "chat_id": "b646d975-0c9c-4872-9f41-8b1e57181063",
    "chat_type": "Buyer_Seller",
    "message_id": "3000000000817031942",
    "created_at": "2022-07-18T20:58:04.528Z",
    "user": {
        "id": "115568",
        "type": "Сustomer"
    },
    "data": [
        "Текст сообщения"
    ],  
    "seller_id": "7"
}
Параметр
Тип Формат Описание
message_type string Тип уведомления — TYPE_NEW_MESSAGE.
chat_id string Идентификатор чата.
chat_type string Тип чата:
Seller_Support — чат с поддержкой.
Buyer_Seller — чат с покупателем.
Seller_Notification — уведомления Ozon.
message_id string Идентификатор сообщения.
created_at string date-time Дата создания сообщения.
user object Информация об отправителе сообщения.
id string Идентификатор отправителя.
type string Тип отправителя:
Customer — покупатель.
Support — поддержка.
NotificationUser — Ozon.
data array of string Массив с содержимым сообщения в формате Markdown.
seller_id integer int64 Идентификатор продавца.

Сообщение в чате изменено

{  
    "message_type": "TYPE_UPDATE_MESSAGE",
    "chat_id": "b646d975-0c9c-4872-9f41-8b1e57181063",
    "chat_type": "Buyer_Seller",
    "message_id": "3000000000817031942",
    "created_at": "2022-07-18T20:58:04.528Z",
    "updated_at": "2022-07-18T20:59:04.528Z",
    "user": {
        "id": "115568",
        "type": "Сustomer"
    },
    "data": [
        "Текст сообщения"
    ], 
    "seller_id": "7"
}
Параметр
Тип Формат Описание
message_type string Тип уведомления — TYPE_UPDATE_MESSAGE.
chat_id string Идентификатор чата.
chat_type string Тип чата:
Seller_Support — чат с поддержкой.
Buyer_Seller — чат с покупателем.
Seller_Notification — уведомления Ozon.
message_id string Идентификатор сообщения.
created_at string date-time Дата создания сообщения.
updated_at string date-time Дата изменения сообщения.
user object Информация об отправителе сообщения.
id string Идентификатор отправителя.
type string Тип отправителя:
Customer — покупатель.
Support — поддержка.
NotificationUser — Ozon.
data array of string Массив с содержимым сообщения в формате Markdown.
seller_id integer int64 Идентификатор продавца.

Ваше сообщение прочитано

{  
    "message_type": "TYPE_MESSAGE_READ",
    "chat_id": "b646d975-0c9c-4872-9f41-8b1e57181063",
    "chat_type": "Buyer_Seller",
    "message_id": "3000000000817031942",
    "created_at": "2022-07-18T20:58:04.528Z",    
    "user": {
        "id": "115568",
        "type": "Сustomer"
    },
    "last_read_message_id": "3000000000817031942",
    "seller_id": "7"
}
Параметр
Тип Формат Описание
message_type string Тип уведомления — TYPE_MESSAGE_READ.
chat_id string Идентификатор чата.
chat_type string Тип чата:
Seller_Support — чат с поддержкой.
Buyer_Seller — чат с покупателем.
Seller_Notification — уведомления Ozon.
message_id string Идентификатор сообщения.
created_at string date-time Дата создания сообщения.
user object Информация о пользователе, прочитавшем сообщение.
id string Идентификатор пользователя.
type string Тип пользователя:
Customer — покупатель.
Support — поддержка.
NotificationUser — Ozon.
last_read_message_id string Идентификатор последнего прочитанного сообщения.
seller_id integer int64 Идентификатор продавца.

Чат закрыт

{  
    "message_type": "TYPE_CHAT_CLOSED",
    "chat_id": "b646d975-0c9c-4872-9f41-8b1e57181063",
    "chat_type": "Buyer_Seller",
    "user": {
        "id": "115568",
        "type": "Сustomer"
    },
    "seller_id": "7"
}
Параметр
Тип Формат Описание
message_type string Тип уведомления — TYPE_CHAT_CLOSED.
chat_id string Идентификатор чата.
chat_type string Тип чата:
Seller_Support — чат с поддержкой.
Buyer_Seller — чат с покупателем.
Seller_Notification — уведомления Ozon.
user object Информация о пользователе, закрывшем чат.
id string Идентификатор пользователя.
type string Тип пользователя:
Customer — покупатель.
Support — поддержка.
NotificationUser — Ozon.
seller_id integer int64 Идентификатор продавца.

Ответ вашего сервиса

Если уведомление получено успешно

При успешной обработке уведомления сервис должен вернуть ответ с кодом HTTP 200:

{
  "result": true
}
Параметр
Тип Формат Описание
result boolean Уведомление получено.

Если произошла ошибка

При ошибке во время обработки уведомления сервис должен вернуть ответ с кодом HTTP из групп 4xx или 5xx:

{
  "error": {
    "code": "ERROR_UNKNOWN",
    "message": "ошибка",
    "details": null
  }
}
Параметр
Тип Формат Описание
error object Информация об ошибке.
code string Код ошибки:
ERROR_UNKNOWN — неизвестная ошибка.
ERROR_PARAMETER_VALUE_MISSED — не указано значение одного или нескольких параметров.
ERROR_REQUEST_DUPLICATED — дублирующийся запрос.
message string Детальное описание ошибки.
details string Дополнительная информация.